aboutsummaryrefslogtreecommitdiffstats
path: root/doc/misc
diff options
context:
space:
mode:
authorKatsumi Yamaoka2010-08-31 23:55:50 +0000
committerKatsumi Yamaoka2010-08-31 23:55:50 +0000
commitc4d82de839ead8d8b534ad11d14edc11d1ddbdb4 (patch)
tree8a228d4c6a1469b36412ca151a798ca66860cb5b /doc/misc
parent51dee5ef43bc84f1d45657c293a2ccb7ae7e1b0a (diff)
downloademacs-c4d82de839ead8d8b534ad11d14edc11d1ddbdb4.tar.gz
emacs-c4d82de839ead8d8b534ad11d14edc11d1ddbdb4.zip
Remove nnultimate.el and related code; Remove nnsoup.el, gnus-soup.el and related code; by Lars Magne Ingebrigtsen <larsi@gnus.org>.
Diffstat (limited to 'doc/misc')
-rw-r--r--doc/misc/gnus.texi336
1 files changed, 5 insertions, 331 deletions
diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi
index 8e2caf5a145..c931a6735aa 100644
--- a/doc/misc/gnus.texi
+++ b/doc/misc/gnus.texi
@@ -632,7 +632,7 @@ Select Methods
632* Getting Mail:: Reading your personal mail with Gnus. 632* Getting Mail:: Reading your personal mail with Gnus.
633* Browsing the Web:: Getting messages from a plethora of Web sources. 633* Browsing the Web:: Getting messages from a plethora of Web sources.
634* IMAP:: Using Gnus as a @acronym{IMAP} client. 634* IMAP:: Using Gnus as a @acronym{IMAP} client.
635* Other Sources:: Reading directories, files, SOUP packets. 635* Other Sources:: Reading directories, files.
636* Combined Groups:: Combining groups into one group. 636* Combined Groups:: Combining groups into one group.
637* Email Based Diary:: Using mails to manage diary events in Gnus. 637* Email Based Diary:: Using mails to manage diary events in Gnus.
638* Gnus Unplugged:: Reading news and mail offline. 638* Gnus Unplugged:: Reading news and mail offline.
@@ -695,7 +695,6 @@ Browsing the Web
695 695
696* Archiving Mail:: 696* Archiving Mail::
697* Web Searches:: Creating groups from articles that match a string. 697* Web Searches:: Creating groups from articles that match a string.
698* Ultimate:: The Ultimate Bulletin Board systems.
699* Web Archive:: Reading mailing list archived on web. 698* Web Archive:: Reading mailing list archived on web.
700* RSS:: Reading RDF site summary. 699* RSS:: Reading RDF site summary.
701* Customizing W3:: Doing stuff to Emacs/W3 from Gnus. 700* Customizing W3:: Doing stuff to Emacs/W3 from Gnus.
@@ -714,19 +713,12 @@ Other Sources
714* Directory Groups:: You can read a directory as if it was a newsgroup. 713* Directory Groups:: You can read a directory as if it was a newsgroup.
715* Anything Groups:: Dired? Who needs dired? 714* Anything Groups:: Dired? Who needs dired?
716* Document Groups:: Single files can be the basis of a group. 715* Document Groups:: Single files can be the basis of a group.
717* SOUP:: Reading @sc{soup} packets ``offline''.
718* Mail-To-News Gateways:: Posting articles via mail-to-news gateways. 716* Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
719 717
720Document Groups 718Document Groups
721 719
722* Document Server Internals:: How to add your own document types. 720* Document Server Internals:: How to add your own document types.
723 721
724SOUP
725
726* SOUP Commands:: Commands for creating and sending @sc{soup} packets
727* SOUP Groups:: A back end for reading @sc{soup} packets.
728* SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
729
730Combined Groups 722Combined Groups
731 723
732* Virtual Groups:: Combining articles from many groups. 724* Virtual Groups:: Combining articles from many groups.
@@ -6850,10 +6842,6 @@ Marked as read by a catchup (@code{gnus-catchup-mark}).
6850@vindex gnus-canceled-mark 6842@vindex gnus-canceled-mark
6851Canceled article (@code{gnus-canceled-mark}) 6843Canceled article (@code{gnus-canceled-mark})
6852 6844
6853@item F
6854@vindex gnus-souped-mark
6855@sc{soup}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
6856
6857@item Q 6845@item Q
6858@vindex gnus-sparse-mark 6846@vindex gnus-sparse-mark
6859Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing 6847Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
@@ -7824,7 +7812,7 @@ This is a rather obscure variable that few will find useful. It's
7824intended for those non-news newsgroups where the back end has to fetch 7812intended for those non-news newsgroups where the back end has to fetch
7825quite a lot to present the summary buffer, and where it's impossible to 7813quite a lot to present the summary buffer, and where it's impossible to
7826go back to parents of articles. This is mostly the case in the 7814go back to parents of articles. This is mostly the case in the
7827web-based groups, like the @code{nnultimate} groups. 7815web-based groups.
7828 7816
7829If you don't use those, then it's safe to leave this as the default 7817If you don't use those, then it's safe to leave this as the default
7830@code{nil}. If you want to use this variable, it should be a regexp 7818@code{nil}. If you want to use this variable, it should be a regexp
@@ -13746,7 +13734,7 @@ The different methods all have their peculiarities, of course.
13746* Getting Mail:: Reading your personal mail with Gnus. 13734* Getting Mail:: Reading your personal mail with Gnus.
13747* Browsing the Web:: Getting messages from a plethora of Web sources. 13735* Browsing the Web:: Getting messages from a plethora of Web sources.
13748* IMAP:: Using Gnus as a @acronym{IMAP} client. 13736* IMAP:: Using Gnus as a @acronym{IMAP} client.
13749* Other Sources:: Reading directories, files, SOUP packets. 13737* Other Sources:: Reading directories, files.
13750* Combined Groups:: Combining groups into one group. 13738* Combined Groups:: Combining groups into one group.
13751* Email Based Diary:: Using mails to manage diary events in Gnus. 13739* Email Based Diary:: Using mails to manage diary events in Gnus.
13752* Gnus Unplugged:: Reading news and mail offline. 13740* Gnus Unplugged:: Reading news and mail offline.
@@ -17407,7 +17395,6 @@ interfaces to these sources.
17407@menu 17395@menu
17408* Archiving Mail:: 17396* Archiving Mail::
17409* Web Searches:: Creating groups from articles that match a string. 17397* Web Searches:: Creating groups from articles that match a string.
17410* Ultimate:: The Ultimate Bulletin Board systems.
17411* Web Archive:: Reading mailing list archived on web. 17398* Web Archive:: Reading mailing list archived on web.
17412* RSS:: Reading RDF site summary. 17399* RSS:: Reading RDF site summary.
17413* Customizing W3:: Doing stuff to Emacs/W3 from Gnus. 17400* Customizing W3:: Doing stuff to Emacs/W3 from Gnus.
@@ -17551,34 +17538,6 @@ Format string URL to fetch an article by @code{Message-ID}.
17551@end table 17538@end table
17552 17539
17553 17540
17554@node Ultimate
17555@subsection Ultimate
17556@cindex nnultimate
17557@cindex Ultimate Bulletin Board
17558
17559@uref{http://www.ultimatebb.com/, The Ultimate Bulletin Board} is
17560probably the most popular Web bulletin board system used. It has a
17561quite regular and nice interface, and it's possible to get the
17562information Gnus needs to keep groups updated.
17563
17564The easiest way to get started with @code{nnultimate} is to say
17565something like the following in the group buffer: @kbd{B nnultimate RET
17566http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @acronym{URL}
17567(not including @samp{Ultimate.cgi} or the like at the end) for a forum
17568you're interested in; there's quite a list of them on the Ultimate web
17569site.) Then subscribe to the groups you're interested in from the
17570server buffer, and read them from the group buffer.
17571
17572The following @code{nnultimate} variables can be altered:
17573
17574@table @code
17575@item nnultimate-directory
17576@vindex nnultimate-directory
17577The directory where @code{nnultimate} stores its files. The default is@*
17578@file{~/News/ultimate/}.
17579@end table
17580
17581
17582@node Web Archive 17541@node Web Archive
17583@subsection Web Archive 17542@subsection Web Archive
17584@cindex nnwarchive 17543@cindex nnwarchive
@@ -18552,7 +18511,6 @@ newsgroups.
18552* Directory Groups:: You can read a directory as if it was a newsgroup. 18511* Directory Groups:: You can read a directory as if it was a newsgroup.
18553* Anything Groups:: Dired? Who needs dired? 18512* Anything Groups:: Dired? Who needs dired?
18554* Document Groups:: Single files can be the basis of a group. 18513* Document Groups:: Single files can be the basis of a group.
18555* SOUP:: Reading @sc{soup} packets ``offline''.
18556* Mail-To-News Gateways:: Posting articles via mail-to-news gateways. 18514* Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
18557@end menu 18515@end menu
18558 18516
@@ -18920,289 +18878,6 @@ correct type. A high number means high probability; a low number
18920means low probability with @samp{0} being the lowest valid number. 18878means low probability with @samp{0} being the lowest valid number.
18921 18879
18922 18880
18923@node SOUP
18924@subsection SOUP
18925@cindex SOUP
18926@cindex offline
18927
18928In the PC world people often talk about ``offline'' newsreaders. These
18929are thingies that are combined reader/news transport monstrosities.
18930With built-in modem programs. Yecchh!
18931
18932Of course, us Unix Weenie types of human beans use things like
18933@code{uucp} and, like, @code{nntpd} and set up proper news and mail
18934transport things like Ghod intended. And then we just use normal
18935newsreaders.
18936
18937However, it can sometimes be convenient to do something that's a bit
18938easier on the brain if you have a very slow modem, and you're not really
18939that interested in doing things properly.
18940
18941A file format called @sc{soup} has been developed for transporting news
18942and mail from servers to home machines and back again. It can be a bit
18943fiddly.
18944
18945First some terminology:
18946
18947@table @dfn
18948
18949@item server
18950This is the machine that is connected to the outside world and where you
18951get news and/or mail from.
18952
18953@item home machine
18954This is the machine that you want to do the actual reading and responding
18955on. It is typically not connected to the rest of the world in any way.
18956
18957@item packet
18958Something that contains messages and/or commands. There are two kinds
18959of packets:
18960
18961@table @dfn
18962@item message packets
18963These are packets made at the server, and typically contain lots of
18964messages for you to read. These are called @file{SoupoutX.tgz} by
18965default, where @var{x} is a number.
18966
18967@item response packets
18968These are packets made at the home machine, and typically contains
18969replies that you've written. These are called @file{SoupinX.tgz} by
18970default, where @var{x} is a number.
18971
18972@end table
18973
18974@end table
18975
18976
18977@enumerate
18978
18979@item
18980You log in on the server and create a @sc{soup} packet. You can either
18981use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
18982can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
18983s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
18984
18985@item
18986You transfer the packet home. Rail, boat, car or modem will do fine.
18987
18988@item
18989You put the packet in your home directory.
18990
18991@item
18992You fire up Gnus on your home machine using the @code{nnsoup} back end as
18993the native or secondary server.
18994
18995@item
18996You read articles and mail and answer and followup to the things you
18997want (@pxref{SOUP Replies}).
18998
18999@item
19000You do the @kbd{G s r} command to pack these replies into a @sc{soup}
19001packet.
19002
19003@item
19004You transfer this packet to the server.
19005
19006@item
19007You use Gnus to mail this packet out with the @kbd{G s s} command.
19008
19009@item
19010You then repeat until you die.
19011
19012@end enumerate
19013
19014So you basically have a bipartite system---you use @code{nnsoup} for
19015reading and Gnus for packing/sending these @sc{soup} packets.
19016
19017@menu
19018* SOUP Commands:: Commands for creating and sending @sc{soup} packets
19019* SOUP Groups:: A back end for reading @sc{soup} packets.
19020* SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
19021@end menu
19022
19023
19024@node SOUP Commands
19025@subsubsection SOUP Commands
19026
19027These are commands for creating and manipulating @sc{soup} packets.
19028
19029@table @kbd
19030@item G s b
19031@kindex G s b (Group)
19032@findex gnus-group-brew-soup
19033Pack all unread articles in the current group
19034(@code{gnus-group-brew-soup}). This command understands the
19035process/prefix convention.
19036
19037@item G s w
19038@kindex G s w (Group)
19039@findex gnus-soup-save-areas
19040Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
19041
19042@item G s s
19043@kindex G s s (Group)
19044@findex gnus-soup-send-replies
19045Send all replies from the replies packet
19046(@code{gnus-soup-send-replies}).
19047
19048@item G s p
19049@kindex G s p (Group)
19050@findex gnus-soup-pack-packet
19051Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
19052
19053@item G s r
19054@kindex G s r (Group)
19055@findex nnsoup-pack-replies
19056Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
19057
19058@item O s
19059@kindex O s (Summary)
19060@findex gnus-soup-add-article
19061This summary-mode command adds the current article to a @sc{soup} packet
19062(@code{gnus-soup-add-article}). It understands the process/prefix
19063convention (@pxref{Process/Prefix}).
19064
19065@end table
19066
19067
19068There are a few variables to customize where Gnus will put all these
19069thingies:
19070
19071@table @code
19072
19073@item gnus-soup-directory
19074@vindex gnus-soup-directory
19075Directory where Gnus will save intermediate files while composing
19076@sc{soup} packets. The default is @file{~/SoupBrew/}.
19077
19078@item gnus-soup-replies-directory
19079@vindex gnus-soup-replies-directory
19080This is what Gnus will use as a temporary directory while sending our
19081reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
19082
19083@item gnus-soup-prefix-file
19084@vindex gnus-soup-prefix-file
19085Name of the file where Gnus stores the last used prefix. The default is
19086@samp{gnus-prefix}.
19087
19088@item gnus-soup-packer
19089@vindex gnus-soup-packer
19090A format string command for packing a @sc{soup} packet. The default is
19091@samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
19092
19093@item gnus-soup-unpacker
19094@vindex gnus-soup-unpacker
19095Format string command for unpacking a @sc{soup} packet. The default is
19096@samp{gunzip -c %s | tar xvf -}.
19097
19098@item gnus-soup-packet-directory
19099@vindex gnus-soup-packet-directory
19100Where Gnus will look for reply packets. The default is @file{~/}.
19101
19102@item gnus-soup-packet-regexp
19103@vindex gnus-soup-packet-regexp
19104Regular expression matching @sc{soup} reply packets in
19105@code{gnus-soup-packet-directory}.
19106
19107@end table
19108
19109
19110@node SOUP Groups
19111@subsubsection SOUP Groups
19112@cindex nnsoup
19113
19114@code{nnsoup} is the back end for reading @sc{soup} packets. It will
19115read incoming packets, unpack them, and put them in a directory where
19116you can read them at leisure.
19117
19118These are the variables you can use to customize its behavior:
19119
19120@table @code
19121
19122@item nnsoup-tmp-directory
19123@vindex nnsoup-tmp-directory
19124When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
19125directory. (@file{/tmp/} by default.)
19126
19127@item nnsoup-directory
19128@vindex nnsoup-directory
19129@code{nnsoup} then moves each message and index file to this directory.
19130The default is @file{~/SOUP/}.
19131
19132@item nnsoup-replies-directory
19133@vindex nnsoup-replies-directory
19134All replies will be stored in this directory before being packed into a
19135reply packet. The default is @file{~/SOUP/replies/}.
19136
19137@item nnsoup-replies-format-type
19138@vindex nnsoup-replies-format-type
19139The @sc{soup} format of the replies packets. The default is @samp{?n}
19140(rnews), and I don't think you should touch that variable. I probably
19141shouldn't even have documented it. Drats! Too late!
19142
19143@item nnsoup-replies-index-type
19144@vindex nnsoup-replies-index-type
19145The index type of the replies packet. The default is @samp{?n}, which
19146means ``none''. Don't fiddle with this one either!
19147
19148@item nnsoup-active-file
19149@vindex nnsoup-active-file
19150Where @code{nnsoup} stores lots of information. This is not an ``active
19151file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
19152this file or mess it up in any way, you're dead. The default is
19153@file{~/SOUP/active}.
19154
19155@item nnsoup-packer
19156@vindex nnsoup-packer
19157Format string command for packing a reply @sc{soup} packet. The default
19158is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
19159
19160@item nnsoup-unpacker
19161@vindex nnsoup-unpacker
19162Format string command for unpacking incoming @sc{soup} packets. The
19163default is @samp{gunzip -c %s | tar xvf -}.
19164
19165@item nnsoup-packet-directory
19166@vindex nnsoup-packet-directory
19167Where @code{nnsoup} will look for incoming packets. The default is
19168@file{~/}.
19169
19170@item nnsoup-packet-regexp
19171@vindex nnsoup-packet-regexp
19172Regular expression matching incoming @sc{soup} packets. The default is
19173@samp{Soupout}.
19174
19175@item nnsoup-always-save
19176@vindex nnsoup-always-save
19177If non-@code{nil}, save the replies buffer after each posted message.
19178
19179@end table
19180
19181
19182@node SOUP Replies
19183@subsubsection SOUP Replies
19184
19185Just using @code{nnsoup} won't mean that your postings and mailings end
19186up in @sc{soup} reply packets automagically. You have to work a bit
19187more for that to happen.
19188
19189@findex nnsoup-set-variables
19190The @code{nnsoup-set-variables} command will set the appropriate
19191variables to ensure that all your followups and replies end up in the
19192@sc{soup} system.
19193
19194In specific, this is what it does:
19195
19196@lisp
19197(setq message-send-news-function 'nnsoup-request-post)
19198(setq message-send-mail-function 'nnsoup-request-mail)
19199@end lisp
19200
19201And that's it, really. If you only want news to go into the @sc{soup}
19202system you just use the first line. If you only want mail to be
19203@sc{soup}ed you use the second.
19204
19205
19206@node Mail-To-News Gateways 18881@node Mail-To-News Gateways
19207@subsection Mail-To-News Gateways 18882@subsection Mail-To-News Gateways
19208@cindex mail-to-news gateways 18883@cindex mail-to-news gateways
@@ -27927,8 +27602,7 @@ news batches, ClariNet briefs collections, and just about everything
27927else (@pxref{Document Groups}). 27602else (@pxref{Document Groups}).
27928 27603
27929@item 27604@item
27930Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets 27605Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets.
27931(@pxref{SOUP}).
27932 27606
27933@item 27607@item
27934The Gnus cache is much faster. 27608The Gnus cache is much faster.
@@ -29492,7 +29166,7 @@ As the variables for the other back ends, there are
29492@code{nnml-nov-is-evil}, @code{nnspool-nov-is-evil}, and 29166@code{nnml-nov-is-evil}, @code{nnspool-nov-is-evil}, and
29493@code{nnwarchive-nov-is-evil}. Note that a non-@code{nil} value for 29167@code{nnwarchive-nov-is-evil}. Note that a non-@code{nil} value for
29494@code{gnus-nov-is-evil} overrides all those variables.@footnote{Although 29168@code{gnus-nov-is-evil} overrides all those variables.@footnote{Although
29495the back ends @code{nnkiboze}, @code{nnultimate}, and 29169+the back ends @code{nnkiboze}, and
29496@code{nnwfm} don't have their own nn*-nov-is-evil.} 29170@code{nnwfm} don't have their own nn*-nov-is-evil.}
29497@end table 29171@end table
29498 29172