gnus-msg.el (gnus-copy-article-buffer): Revome smiley extents for XEmacs 21.1
[elisp/gnus.git-] / README-offline.en
1 1) What's "gnus-offline (Gnus Offline Backend Utility)" ?
2 =========================================================
3
4 This program is a utility for T-gnus that handles messages
5 (i.e. mail and news) in the "offline" state in a more simple way.
6
7 It is basically designed for "gnus-agent". (See info about gnus-agent.)
8
9 You can also use it with a function "nnspool"(*1) (which needs an
10 external program such as "gnspool"(*2) ), or with "miee.el"(*3) for
11 posting and/or sending messages.
12
13      (*1) See info about nnspool.
14      (*2) gnspool comes with a newsreader "gn".
15      (*3) The latest version of miee.el (or MIEE) is available at
16           http://www.shiojiri.ne.jp/%7Et-ichi/meadow.html
17
18 You can handle messages in the offline state without "gnus-offline",
19 but "gnus-offline" provides a simple way for setup and operation.
20
21 **Features**
22
23 o Simple configuration -- An "INTERACTIVE" configuration to set
24          the variables.
25
26 o Simple operation -- Type "g" in the *Group* buffer, and gnus-offline
27          will:
28            o Dial (*)
29            o Send mails & post news articles
30            o Fetch new mails & articles
31            o Hang up (*)
32
33       (*) For dialing and hanging up, external softwares are needed.
34           But you can do without ones if you connect and disconnect
35           manually.
36
37 This document is written mainly for the case using "gnus-agent" with
38 gnus-offline.el bundled in T-gnus 6.12.0 or later.
39
40 2) Installation
41 ===============
42
43 As you are reading this document, this version of T-gnus includes
44 gnus-offline. Installation is simple. "make install" will
45 automatically install "gnus-offline".
46
47 3) How to use
48 =============
49
50 o First, you must do a general setup for T-gnus (See info about the
51   setup).
52
53 o Add the following code to ~/.emacs
54
55         (autoload 'gnus-plugged "gnus-agent" nil t)
56         (autoload 'gnus-unplugged "gnus-agent" nil t)
57
58 o Add the following code to ~/.emacs
59
60         (load "gnus-ofsetup")
61         (gnus-setup-for-offline)
62
63 o Add the following code to ~/.gnus
64
65         (gnus-agentize)
66
67 o Restart Emacs. gnus-ofsetup.el will ask you some questions and
68  create ~/.gnus-offline.el. (*)
69
70       (*) If you don't know how to answer some questions, typing "TAB"
71           key may show you the possible answers. See the next section
72           which explains the user options.
73           You will also be asked whether to save the POP password in
74           ~/.newsrc.eld or not. Answer it carefully. See section 6)
75           for details.
76
77 o At the first time, you must start Gnus in the online state
78  (by M-x gnus-plugged) and decide which groups to subscribe (See info
79  about subscribing).
80
81  From now on you can start Gnus as an offline reader by M-x gnus-unplugged.
82  Try typing "g" in the *Group* buffer.
83
84 o You may want M-x gnus to start Gnus as an offline reader as
85  M-x gnus-unplugged. Then write the following code to ~/.emacs
86
87         (setq gnus-plugged nil)
88
89  you can put it into ~/.gnus if there's no need to start Gnus as an online
90  reader (by M-x gnus-plugged).
91
92 4) User customizable variables in gnus-offline
93 ==============================================
94
95 o gnus-offline-dialup-program
96     Program name to dialup.
97
98 o gnus-offline-dialup-program-arguments
99     List of dialup program arguments.
100
101 o gnus-offline-hangup-program
102     Program name to hangup.
103
104 o gnus-offline-hangup-program-arguments
105     List of hangup program arguments.
106
107 o gnus-offline-mail-spool-directory
108     Spool directory for sending mail.
109     This variable is available only using MIEE.
110
111 o gnus-offline-news-spool-directory
112     Spool directory for sending news.
113     This variable is available only using MIEE.
114
115 o gnus-offline-mail-treat-environ
116     If t , gnus-offline sends mail to spool first.
117     If nil , gnus-offline sends mail immediately.
118
119 o gnus-offline-articles-to-fetch
120     Article type you want to fetch.
121
122        'both ... Fetch both Mail/News.
123        'Mail ... Fetch only Mail.
124        'News ... Fetch only News.
125
126     Default value is both.
127
128 o gnus-offline-load-hook
129     Hook before gnus-offline load.
130
131 o gnus-offline-before-online-hook
132     Hook before all online jobs.
133
134 o gnus-offline-after-online-hook
135     Hook after all online jobs.
136
137 o gnus-offline-interval-time
138     Interval time to do all online jobs.(minutes)
139
140 o gnus-offline-MTA-type
141     MTA type to sending mail.
142
143    'smtp     ... Use smtp.el.
144    'sendmail ... Use sendmail.el.
145
146 o gnus-offline-drafts-queue-type
147    Message queue type when spooling message.
148
149    'miee  ... Use miee.el.
150    'agent ... Use gnus-agent.el.
151
152 o gnus-offline-after-empting-spool-hook
153    Hook before empting spool.
154
155 o gnus-offline-before-empting-spool-hook
156    Hook after emoting spool.
157
158 o gnus-offline-dialup-function
159    Function to dialup.
160
161 o gnus-offline-hangup-function
162    Function to hangup.
163
164 5) Commands in gnus-offline
165 ===========================
166
167 o M-x gnus-offline-toggle-plugged
168    Toggle offline/online state.
169
170 o M-x gnus-offline-toggle-auto-hangup
171    Change current state to offline.
172
173 o M-x gnus-offline-toggle-on/off-send-mail
174    Toggle method to sending mail.
175
176 o M-x gnus-offline-toggle-articles-to-fetch
177    Toggle articles you want to fetch.
178
179 o M-x gnus-offline-set-interval-time
180    Set interval time(minute) to fetch article.
181
182 o M-x gnus-offline-agent-expire
183    Expire articles.
184
185 6) [!!!IMPORTANT!!!] About the pop password
186 ===========================================
187
188 If your machine is stand alone, and nobody else uses it, you can save
189 the password. (But, on your own responsibility!)
190
191 At the first interactive configuration, it will ask you whether to
192 save the password in ~/.newsrc.eld or not. When you answer "y" to this
193 question, the password will be saved in ~/.newsrc.eld. (*)
194
195        (*) Actually the following will be added to ~/.gnus-offline.el.
196
197             (add-hook
198              'gnus-setup-news-hook
199              (lambda ()
200                (add-to-list 'gnus-variable-list 'mail-source-password-cache)))
201
202 Answer this question carefully, because the password will NOT be
203 encoded!