aboutsummaryrefslogtreecommitdiffstats
path: root/doc/misc/gnus.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/misc/gnus.texi')
-rw-r--r--doc/misc/gnus.texi197
1 files changed, 103 insertions, 94 deletions
diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi
index 1a1f0d48eb9..2df6d90cc07 100644
--- a/doc/misc/gnus.texi
+++ b/doc/misc/gnus.texi
@@ -1020,22 +1020,6 @@ Gnus will see whether @code{gnus-nntpserver-file}
1020If that fails as well, Gnus will try to use the machine running Emacs 1020If that fails as well, Gnus will try to use the machine running Emacs
1021as an @acronym{NNTP} server. That's a long shot, though. 1021as an @acronym{NNTP} server. That's a long shot, though.
1022 1022
1023@vindex gnus-nntp-server
1024If @code{gnus-nntp-server} is set, this variable will override
1025@code{gnus-select-method}. You should therefore set
1026@code{gnus-nntp-server} to @code{nil}, which is what it is by default.
1027
1028@vindex gnus-secondary-servers
1029@vindex gnus-nntp-server
1030You can also make Gnus prompt you interactively for the name of an
1031@acronym{NNTP} server. If you give a non-numerical prefix to @code{gnus}
1032(i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
1033in the @code{gnus-secondary-servers} list (if any). You can also just
1034type in the name of any server you feel like visiting. (Note that this
1035will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
1036gnus} later in the same Emacs session, Gnus will contact the same
1037server.)
1038
1039@findex gnus-group-browse-foreign-server 1023@findex gnus-group-browse-foreign-server
1040@kindex B (Group) 1024@kindex B (Group)
1041However, if you use one @acronym{NNTP} server regularly and are just 1025However, if you use one @acronym{NNTP} server regularly and are just
@@ -2211,6 +2195,12 @@ selected.
2211@section Subscription Commands 2195@section Subscription Commands
2212@cindex subscription 2196@cindex subscription
2213 2197
2198The following commands allow for managing your subscriptions in the
2199Group buffer. If you want to subscribe to many groups, it's probably
2200more convenient to go to the @ref{Server Buffer}, and choose the
2201server there using @kbd{RET} or @kbd{SPC}. Then you'll have the
2202commands listed in @ref{Browse Foreign Server} at hand.
2203
2214@table @kbd 2204@table @kbd
2215 2205
2216@item S t 2206@item S t
@@ -2409,6 +2399,9 @@ one with the best level.
2409All groups with a level less than or equal to 2399All groups with a level less than or equal to
2410@code{gnus-group-default-list-level} will be listed in the group buffer 2400@code{gnus-group-default-list-level} will be listed in the group buffer
2411by default. 2401by default.
2402This variable can also be a function. In that case, that function will
2403be called and the result will be used as value.
2404
2412 2405
2413@vindex gnus-group-list-inactive-groups 2406@vindex gnus-group-list-inactive-groups
2414If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active 2407If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
@@ -3085,8 +3078,8 @@ The Sieve language is described in RFC 3028. @xref{Top, Emacs Sieve,
3085Top, sieve, Emacs Sieve}. 3078Top, sieve, Emacs Sieve}.
3086 3079
3087@item (agent parameters) 3080@item (agent parameters)
3088If the agent has been enabled, you can set any of the its parameters 3081If the agent has been enabled, you can set any of its parameters to
3089to control the behavior of the agent in individual groups. See Agent 3082control the behavior of the agent in individual groups. See Agent
3090Parameters in @ref{Category Syntax}. Most users will choose to set 3083Parameters in @ref{Category Syntax}. Most users will choose to set
3091agent parameters in either an agent category or group topic to 3084agent parameters in either an agent category or group topic to
3092minimize the configuration effort. 3085minimize the configuration effort.
@@ -4563,7 +4556,7 @@ However, you can also create e.g. a new @code{nnmaildir} or @code{nnml}
4563server exclusively for @code{nnmairix} in your secondary select methods 4556server exclusively for @code{nnmairix} in your secondary select methods
4564(@pxref{Finding the News}). If you use a secondary @code{nnml} server 4557(@pxref{Finding the News}). If you use a secondary @code{nnml} server
4565just for mairix, make sure that you explicitly set the server variable 4558just for mairix, make sure that you explicitly set the server variable
4566@code{nnml-get-new-mail} to @code{nil}, or you might loose mail 4559@code{nnml-get-new-mail} to @code{nil}, or you might lose mail
4567(@pxref{nnmairix caveats}). If you want to use mairix remotely on an 4560(@pxref{nnmairix caveats}). If you want to use mairix remotely on an
4568@acronym{IMAP} server, you have to choose the corresponding 4561@acronym{IMAP} server, you have to choose the corresponding
4569@code{nnimap} server here. 4562@code{nnimap} server here.
@@ -5195,24 +5188,6 @@ used for fetching the file.
5195If fetching from the first site is unsuccessful, Gnus will attempt to go 5188If fetching from the first site is unsuccessful, Gnus will attempt to go
5196through @code{gnus-group-faq-directory} and try to open them one by one. 5189through @code{gnus-group-faq-directory} and try to open them one by one.
5197 5190
5198@item H C
5199@kindex H C (Group)
5200@findex gnus-group-fetch-control
5201@vindex gnus-group-fetch-control-use-browse-url
5202@cindex control message
5203Fetch the control messages for the group from the archive at
5204@code{ftp.isc.org} (@code{gnus-group-fetch-control}). Query for a
5205group if given a prefix argument.
5206
5207If @code{gnus-group-fetch-control-use-browse-url} is non-@code{nil},
5208Gnus will open the control messages in a browser using
5209@code{browse-url}. Otherwise they are fetched using @code{ange-ftp}
5210and displayed in an ephemeral group.
5211
5212Note that the control messages are compressed. To use this command
5213you need to turn on @code{auto-compression-mode} (@pxref{Compressed
5214Files, ,Compressed Files, emacs, The Emacs Manual}).
5215
5216@item H d 5191@item H d
5217@itemx C-c C-d 5192@itemx C-c C-d
5218@c @icon{gnus-group-describe-group} 5193@c @icon{gnus-group-describe-group}
@@ -6177,9 +6152,10 @@ Scroll the current article one line backward
6177@findex gnus-summary-show-article 6152@findex gnus-summary-show-article
6178@vindex gnus-summary-show-article-charset-alist 6153@vindex gnus-summary-show-article-charset-alist
6179(Re)fetch the current article (@code{gnus-summary-show-article}). If 6154(Re)fetch the current article (@code{gnus-summary-show-article}). If
6180given a prefix, fetch the current article, but don't run any of the 6155given a prefix, show a completely ``raw'' article, just the way it
6181article treatment functions. This will give you a ``raw'' article, just 6156came from the server. If given a prefix twice (i.e., @kbd{C-u C-u
6182the way it came from the server. 6157g'}), fetch the current article, but don't run any of the article
6158treatment functions.
6183 6159
6184@cindex charset, view article with different charset 6160@cindex charset, view article with different charset
6185If given a numerical prefix, you can do semi-manual charset stuff. 6161If given a numerical prefix, you can do semi-manual charset stuff.
@@ -9688,6 +9664,17 @@ an attempt to provide more quoting characters. If you see something
9688like @code{\222} or @code{\264} where you're expecting some kind of 9664like @code{\222} or @code{\264} where you're expecting some kind of
9689apostrophe or quotation mark, then try this wash. 9665apostrophe or quotation mark, then try this wash.
9690 9666
9667@item W U
9668@kindex W U (Summary)
9669@findex gnus-article-treat-non-ascii
9670@cindex Unicode
9671@cindex Non-@acronym{ASCII}
9672Translate many non-@acronym{ASCII} characters into their
9673@acronym{ASCII} equivalents (@code{gnus-article-treat-non-ascii}).
9674This is mostly useful if you're on a terminal that has a limited font
9675and does't show accented characters, ``advanced'' punctuation, and the
9676like. For instance, @samp{»} is tranlated into @samp{>>}, and so on.
9677
9691@item W Y f 9678@item W Y f
9692@kindex W Y f (Summary) 9679@kindex W Y f (Summary)
9693@findex gnus-article-outlook-deuglify-article 9680@findex gnus-article-outlook-deuglify-article
@@ -9803,19 +9790,16 @@ If a prefix is given, a charset will be asked for. If it is a number,
9803the charset defined in @code{gnus-summary-show-article-charset-alist} 9790the charset defined in @code{gnus-summary-show-article-charset-alist}
9804(@pxref{Paging the Article}) will be used. 9791(@pxref{Paging the Article}) will be used.
9805 9792
9806@vindex gnus-article-wash-function
9807The default is to use the function specified by 9793The default is to use the function specified by
9808@code{mm-text-html-renderer} (@pxref{Display Customization, ,Display 9794@code{mm-text-html-renderer} (@pxref{Display Customization, ,Display
9809Customization, emacs-mime, The Emacs MIME Manual}) to convert the 9795Customization, emacs-mime, The Emacs MIME Manual}) to convert the
9810@acronym{HTML}, but this is controlled by the 9796@acronym{HTML}. Pre-defined functions you can use include:
9811@code{gnus-article-wash-function} variable. Pre-defined functions you
9812can use include:
9813 9797
9814@table @code 9798@table @code
9815@item mm-shr 9799@item shr
9816Use Gnus simple html renderer. 9800Use Gnus simple html renderer.
9817 9801
9818@item gnus-article-html 9802@item gnus-w3m
9819Use Gnus rendered based on w3m. 9803Use Gnus rendered based on w3m.
9820 9804
9821@item w3 9805@item w3
@@ -12462,15 +12446,22 @@ that's based on @code{w3m}.
12462 12446
12463@item gnus-blocked-images 12447@item gnus-blocked-images
12464@vindex gnus-blocked-images 12448@vindex gnus-blocked-images
12465Images that have @acronym{URL}s that match this regexp won't be 12449External images that have @acronym{URL}s that match this regexp won't
12466fetched and displayed. For instance, do block all @acronym{URL}s that 12450be fetched and displayed. For instance, do block all @acronym{URL}s
12467have the string ``ads'' in them, do the following: 12451that have the string ``ads'' in them, do the following:
12468 12452
12469@lisp 12453@lisp
12470(setq gnus-blocked-images "ads") 12454(setq gnus-blocked-images "ads")
12471@end lisp 12455@end lisp
12472 12456
12473The default is to block all external images. 12457This can also be a function to be evaluated. If so, it will be
12458called with the group name as the parameter. The default value is
12459@code{gnus-block-private-groups}, which will return @samp{"."} for
12460anything that isn't a newsgroup. This means that no external images
12461will be fetched as a result of reading mail, so that nobody can use
12462web bugs (and the like) to track whether you've read email.
12463
12464Also @pxref{Misc Article} for @code{gnus-inhibit-images}.
12474 12465
12475@item gnus-html-cache-directory 12466@item gnus-html-cache-directory
12476@vindex gnus-html-cache-directory 12467@vindex gnus-html-cache-directory
@@ -12952,6 +12943,15 @@ for how to compose such messages. This requires
12952@uref{http://www.gnu.org/software/libidn/, GNU Libidn}, and this 12943@uref{http://www.gnu.org/software/libidn/, GNU Libidn}, and this
12953variable is only enabled if you have installed it. 12944variable is only enabled if you have installed it.
12954 12945
12946@vindex gnus-inhibit-images
12947@item gnus-inhibit-images
12948If this is non-@code{nil}, inhibit displaying of images inline in the
12949article body. It is effective to images that are in articles as
12950@acronym{MIME} parts, and images in @acronym{HTML} articles rendered
12951when @code{mm-text-html-renderer} (@pxref{Display Customization,
12952,Display Customization, emacs-mime, The Emacs MIME Manual}) is
12953@code{shr} or @code{gnus-w3m}.
12954
12955@end table 12955@end table
12956 12956
12957 12957
@@ -13342,21 +13342,6 @@ case you should set @code{gnus-message-archive-group} to @code{nil};
13342this will disable archiving. 13342this will disable archiving.
13343 13343
13344@table @code 13344@table @code
13345@item gnus-outgoing-message-group
13346@vindex gnus-outgoing-message-group
13347All outgoing messages will be put in this group. If you want to store
13348all your outgoing mail and articles in the group @samp{nnml:archive},
13349you set this variable to that value. This variable can also be a list of
13350group names.
13351
13352If you want to have greater control over what group to put each
13353message in, you can set this variable to a function that checks the
13354current newsgroup name and then returns a suitable group name (or list
13355of names).
13356
13357This variable can be used instead of @code{gnus-message-archive-group},
13358but the latter is the preferred method.
13359
13360@item gnus-gcc-mark-as-read 13345@item gnus-gcc-mark-as-read
13361@vindex gnus-gcc-mark-as-read 13346@vindex gnus-gcc-mark-as-read
13362If non-@code{nil}, automatically mark @code{Gcc} articles as read. 13347If non-@code{nil}, automatically mark @code{Gcc} articles as read.
@@ -13451,14 +13436,20 @@ the headers of the article; if the value is @code{nil}, the header
13451name will be removed. If the attribute name is @code{eval}, the form 13436name will be removed. If the attribute name is @code{eval}, the form
13452is evaluated, and the result is thrown away. 13437is evaluated, and the result is thrown away.
13453 13438
13454The attribute value can be a string (used verbatim), a function with 13439The attribute value can be a string, a function with zero arguments
13455zero arguments (the return value will be used), a variable (its value 13440(the return value will be used), a variable (its value will be used)
13456will be used) or a list (it will be @code{eval}ed and the return value 13441or a list (it will be @code{eval}ed and the return value will be
13457will be used). The functions and sexps are called/@code{eval}ed in the 13442used). The functions and sexps are called/@code{eval}ed in the
13458message buffer that is being set up. The headers of the current article 13443message buffer that is being set up. The headers of the current
13459are available through the @code{message-reply-headers} variable, which 13444article are available through the @code{message-reply-headers}
13460is a vector of the following headers: number subject from date id 13445variable, which is a vector of the following headers: number subject
13461references chars lines xref extra. 13446from date id references chars lines xref extra.
13447
13448In the case of a string value, if the @code{match} is a regular
13449expression, a @samp{gnus-match-substitute-replacement} is proceed on
13450the value to replace the positional parameters @samp{\@var{n}} by the
13451corresponding parenthetical matches (see @xref{Replacing the Text that
13452Matched, , Text Replacement, elisp, The Emacs Lisp Reference Manual}.)
13462 13453
13463@vindex message-reply-headers 13454@vindex message-reply-headers
13464 13455
@@ -13834,6 +13825,11 @@ Add a new server (@code{gnus-server-add-server}).
13834@findex gnus-server-edit-server 13825@findex gnus-server-edit-server
13835Edit a server (@code{gnus-server-edit-server}). 13826Edit a server (@code{gnus-server-edit-server}).
13836 13827
13828@item S
13829@kindex S (Server)
13830@findex gnus-server-show-server
13831Show the definition of a server (@code{gnus-server-show-server}).
13832
13837@item SPACE 13833@item SPACE
13838@kindex SPACE (Server) 13834@kindex SPACE (Server)
13839@findex gnus-server-read-server 13835@findex gnus-server-read-server
@@ -13889,6 +13885,9 @@ hence getting a correct total article count.
13889 13885
13890@end table 13886@end table
13891 13887
13888Some more commands for closing, disabling, and re-opening servers are
13889listed in @ref{Unavailable Servers}.
13890
13892 13891
13893@node Example Methods 13892@node Example Methods
13894@subsection Example Methods 13893@subsection Example Methods
@@ -14442,7 +14441,9 @@ functions is also affected by commonly understood variables
14442@findex nntp-open-network-stream 14441@findex nntp-open-network-stream
14443@item nntp-open-network-stream 14442@item nntp-open-network-stream
14444This is the default, and simply connects to some port or other on the 14443This is the default, and simply connects to some port or other on the
14445remote system. 14444remote system. If both Emacs and the server supports it, the
14445connection will be upgraded to an encrypted @acronym{STARTTLS}
14446connection automatically.
14446 14447
14447@findex nntp-open-tls-stream 14448@findex nntp-open-tls-stream
14448@item nntp-open-tls-stream 14449@item nntp-open-tls-stream
@@ -14861,9 +14862,7 @@ Here's an example method that's more complex:
14861 (nnimap-inbox "INBOX") 14862 (nnimap-inbox "INBOX")
14862 (nnimap-split-methods default) 14863 (nnimap-split-methods default)
14863 (nnimap-expunge t) 14864 (nnimap-expunge t)
14864 (nnimap-stream ssl) 14865 (nnimap-stream ssl))
14865 (nnir-search-engine imap)
14866 (nnimap-expunge-inbox t))
14867@end example 14866@end example
14868 14867
14869@table @code 14868@table @code
@@ -14872,18 +14871,23 @@ The address of the server, like @samp{imap.gmail.com}.
14872 14871
14873@item nnimap-server-port 14872@item nnimap-server-port
14874If the server uses a non-standard port, that can be specified here. A 14873If the server uses a non-standard port, that can be specified here. A
14875typical port would be @samp{imap} or @samp{imaps}. 14874typical port would be @code{"imap"} or @code{"imaps"}.
14876 14875
14877@item nnimap-stream 14876@item nnimap-stream
14878How @code{nnimap} should connect to the server. Possible values are: 14877How @code{nnimap} should connect to the server. Possible values are:
14879 14878
14880@table @code 14879@table @code
14880@item undecided
14881This is the default, and this first tries the @code{ssl} setting, and
14882then tries the @code{network} setting.
14883
14881@item ssl 14884@item ssl
14882This is the default, and this uses standard 14885This uses standard @acronym{TLS}/@acronym{SSL} connections.
14883@acronym{TLS}/@acronym{SSL} connection.
14884 14886
14885@item network 14887@item network
14886Non-encrypted and unsafe straight socket connection. 14888Non-encrypted and unsafe straight socket connection, but will upgrade
14889to encrypted @acronym{STARTTLS} if both Emacs and the server
14890supports it.
14887 14891
14888@item starttls 14892@item starttls
14889Encrypted @acronym{STARTTLS} over the normal @acronym{IMAP} port. 14893Encrypted @acronym{STARTTLS} over the normal @acronym{IMAP} port.
@@ -14899,6 +14903,11 @@ what you need.
14899Some @acronym{IMAP} servers allow anonymous logins. In that case, 14903Some @acronym{IMAP} servers allow anonymous logins. In that case,
14900this should be set to @code{anonymous}. 14904this should be set to @code{anonymous}.
14901 14905
14906@item nnimap-expunge
14907If non-@code{nil}, expunge articles after deleting them. This is always done
14908if the server supports UID EXPUNGE, but it's not done by default on
14909servers that doesn't support that command.
14910
14902@item nnimap-streaming 14911@item nnimap-streaming
14903Virtually all @code{IMAP} server support fast streaming of data. If 14912Virtually all @code{IMAP} server support fast streaming of data. If
14904you have problems connecting to the server, try setting this to @code{nil}. 14913you have problems connecting to the server, try setting this to @code{nil}.
@@ -14934,6 +14943,11 @@ use the value of the @code{nnmail-split-methods} variable.
14934@item nnimap-split-fancy 14943@item nnimap-split-fancy
14935Uses the same syntax as @code{nnmail-split-fancy}. 14944Uses the same syntax as @code{nnmail-split-fancy}.
14936 14945
14946@item nnimap-unsplittable-articles
14947List of flag symbols to ignore when doing splitting. That is,
14948articles that have these flags won't be considered when splitting.
14949The default is @samp{(%Deleted %Seen)}.
14950
14937@end table 14951@end table
14938 14952
14939 14953
@@ -17711,15 +17725,6 @@ If you set @code{nnrss-use-local} to @code{t}, @code{nnrss} will read
17711the feeds from local files in @code{nnrss-directory}. You can use 17725the feeds from local files in @code{nnrss-directory}. You can use
17712the command @code{nnrss-generate-download-script} to generate a 17726the command @code{nnrss-generate-download-script} to generate a
17713download script using @command{wget}. 17727download script using @command{wget}.
17714
17715@item nnrss-wash-html-in-text-plain-parts
17716Non-@code{nil} means that @code{nnrss} renders text in @samp{text/plain}
17717parts as @acronym{HTML}. The function specified by the
17718@code{mm-text-html-renderer} variable (@pxref{Display Customization,
17719,Display Customization, emacs-mime, The Emacs MIME Manual}) will be used
17720to render text. If it is @code{nil}, which is the default, text will
17721simply be folded. Leave it @code{nil} if you prefer to see
17722@samp{text/html} parts.
17723@end table 17728@end table
17724 17729
17725The following code may be helpful, if you want to show the description in 17730The following code may be helpful, if you want to show the description in
@@ -17969,6 +17974,10 @@ A @acronym{MIME} digest of messages.
17969@item lanl-gov-announce 17974@item lanl-gov-announce
17970Announcement messages from LANL Gov Announce. 17975Announcement messages from LANL Gov Announce.
17971 17976
17977@cindex git commit messages
17978@item git
17979@code{git} commit messages.
17980
17972@cindex forwarded messages 17981@cindex forwarded messages
17973@item rfc822-forward 17982@item rfc822-forward
17974A message forwarded according to RFC822. 17983A message forwarded according to RFC822.
@@ -19856,7 +19865,7 @@ limit to control how often the cycling occurs. A large value improves
19856performance. A small value minimizes the time lost should the 19865performance. A small value minimizes the time lost should the
19857connection be lost while fetching (You may need to run 19866connection be lost while fetching (You may need to run
19858@code{gnus-agent-regenerate-group} to update the group's state. 19867@code{gnus-agent-regenerate-group} to update the group's state.
19859However, all articles parsed prior to loosing the connection will be 19868However, all articles parsed prior to losing the connection will be
19860available while unplugged). The default is 10M so it is unusual to 19869available while unplugged). The default is 10M so it is unusual to
19861see any cycling. 19870see any cycling.
19862 19871
@@ -30096,11 +30105,11 @@ that means:
30096(setq gnus-read-active-file 'some) 30105(setq gnus-read-active-file 'some)
30097@end lisp 30106@end lisp
30098 30107
30099On the other hand, if the manual says ``set @code{gnus-nntp-server} to 30108On the other hand, if the manual says ``set @code{gnus-nntp-server-file} to
30100@samp{nntp.ifi.uio.no}'', that means: 30109@samp{/etc/nntpserver}'', that means:
30101 30110
30102@lisp 30111@lisp
30103(setq gnus-nntp-server "nntp.ifi.uio.no") 30112(setq gnus-nntp-server-file "/etc/nntpserver")
30104@end lisp 30113@end lisp
30105 30114
30106So be careful not to mix up strings (the latter) with symbols (the 30115So be careful not to mix up strings (the latter) with symbols (the