1999-02-18 Tatsuya Ichikawa <t-ichi@po.shiojiri.ne.jp>
[elisp/gnus.git-] / README-offline.en
1 1) What's "gnus-offline (Gnus Offline Backend Utility)" ?\r
2 =========================================================\r
3 \r
4 This program is a utility for Semi-gnus that handles messages\r
5 (i.e. mail and news) in the "offline" state in a more simple way.\r
6 \r
7 It is basically designed for "gnus-agent". (See info about gnus-agent.)\r
8 \r
9 You can also use it with a function "nnspool"(*1) (which needs an\r
10 external program such as "gnspool"(*2) ), or with "miee.el"(*3) for\r
11 posting and/or sending messages.\r
12 \r
13      (*1) See info about nnspool.\r
14      (*2) gnspool comes with a newsreader "gn".\r
15      (*3) The latest version of miee.el (or MIEE) is available at\r
16           http://www.shiojiri.ne.jp/%7Et-ichi/meadow.html\r
17 \r
18 You can handle messages in the offline state without "gnus-offline",\r
19 but "gnus-offline" provides a simple way for setup and operation.\r
20 \r
21 **Features**\r
22 \r
23 o Simple configuration -- An "INTERACTIVE" configuration to set\r
24          the variables.\r
25 \r
26 o Simple operation -- Type "g" in the *Group* buffer, and gnus-offline \r
27          will:\r
28            o Dial (*)\r
29            o Send mails & post news articles\r
30            o Fetch new mails & articles\r
31            o Hang up (*)\r
32 \r
33       (*) For dialing and hanging up, external softwares are needed.\r
34           But you can do without ones if you connect and disconnect\r
35           manually.\r
36 \r
37 This document is written mainly for the case using "gnus-agent" with\r
38 gnus-offline.el bundled in Semi-gnus. (*)\r
39 \r
40       (*) T-gnus is based on the latest test version of Gnus. It is\r
41           called Pterodactyl Gnus or pGnus.\r
42           Most versions of Semi-gnus other than T-gnus are based on\r
43           Gnus version 5.6.xx.\r
44           There are a lot of changes between Gnus 5.6.xx and pGnus.\r
45           This document will refer to the differences caused by the\r
46           changes when it is important.\r
47 \r
48 2) Installation\r
49 ===============\r
50 \r
51 As you are reading this document, this version of Semi-gnus includes\r
52 gnus-offline. Installation is simple. "make install" will\r
53 automatically install "gnus-offline".\r
54 \r
55 If the Semi-gnus comes without gnus-offline, or you want to install\r
56 the latest version of gnus-offline, you may manually byte-compile\r
57 "gnus-offline.el" and "gnus-ofsetup.el". Make sure they are in one of\r
58 the `load-path' directories. \r
59 \r
60 3) How to use\r
61 =============\r
62 \r
63 o First, you must do a general setup for Semi-gnus (See info about the \r
64  setup).\r
65 \r
66 o Add the following code to ~/.emacs\r
67 \r
68         (load "gnus-ofsetup")\r
69         (gnus-setup-for-offline)\r
70         (load gnus-offline-setting-file)\r
71 \r
72 o Add the following code to ~/.gnus\r
73 \r
74         (gnus-agentize)\r
75 \r
76 o Restart Emacs. gnus-ofsetup.el will ask you some questions and\r
77  create ~/.gnus-offline.el. (*)\r
78 \r
79       (*) If you don't know how to answer some questions, typing "TAB"\r
80           key may show you the possible answers. See the next section\r
81           which explains the user options.\r
82           You will also be asked whether to save the POP password in\r
83           ~/.newsrc.eld or not. Answer it carefully. See section 6)\r
84           for details.\r
85 \r
86 o At the first time, you must start Gnus in the "online" state and\r
87  decide which groups to subscribe (See info about subscribing).\r
88 \r
89 o Add the following code to ~/.gnus\r
90 \r
91         (gnus-agent-toggle-plugged nil)\r
92 \r
93 That's all. Restart Gnus and try typing "g" in the *Group* buffer.\r
94 \r
95 ***Note***\r
96 \r
97 Most versions of Semi-gnus have pop3-fma.el to operate multiple POP\r
98 accounts. T-gnus 6.10.56 or later does not because it can handle\r
99 multiple POP accounts itself.\r
100 \r
101 <<<<<ATTENTION!!>>>>>\r
102 T-gnus 6.10.56 or later doesn't contain "pop3-fma.el". If you are\r
103 updating to T-gnus 6.10.56 or later, remove the setting for\r
104 pop3-fma.el (or simply, delete the old ~/.gnus-offline.el).\r
105 \r
106 [Semi-gnus with pop3-fma.el]\r
107 o pop3-fma-spool-file-alist \r
108 \e$B!!!!!!!!\e(B'(\r
109         ("po:account1@pop-server1" pass) \r
110         ("po:account2@pop-server2" pass) \r
111         :\r
112         :\r
113         ))\r
114 o pop3-fma-movemail-type \r
115       use movemail.exe ('exe) or pop3.el('lisp) \r
116 \r
117 [T-gnus 6.10.56 or later]\r
118 \r
119 o gnus-offline-mail-source \r
120         '(\r
121         (pop :user "manbou" :server "pop.ceres.dti.ne.jp")\r
122         (pop :user "imp9397" :server "mvb.biglobe.ne.jp")\r
123         :\r
124         :\r
125         ) \r
126 \r
127 \r
128 4) User customizable variables in gnus-offline\r
129 ==============================================\r
130 \r
131 o gnus-offline-dialup-program  \r
132     Program name to dialup.\r
133 \r
134 o gnus-offline-dialup-program-arguments\r
135     List of dialup program arguments.\r
136 \r
137 o gnus-offline-hangup-program\r
138     Program name to hangup.\r
139 \r
140 o gnus-offline-hangup-program-arguments\r
141     List of hangup program arguments.\r
142 \r
143 o gnus-offline-mail-spool-directory\r
144     Spool directory for sending mail.\r
145     This variable is available only using MIEE.\r
146 \r
147 o gnus-offline-news-spool-directory\r
148     Spool directory for sending news.\r
149     This variable is available only using MIEE.\r
150 \r
151 o gnus-offline-mail-treat-environ\r
152     If t , gnus-offline sends mail to spool first.\r
153     If nil , gnus-offline sends mail immediately.\r
154 \r
155 o gnus-offline-articles-to-fetch\r
156     Article type you want to fetch.\r
157 \r
158        'both ... Fetch both Mail/News.\r
159        'Mail ... Fetch only Mail.\r
160        'News ... Fetch only News.\r
161 \r
162     Default value is both.\r
163 \r
164 o gnus-offline-load-hook\r
165     Hook before gnus-offline load.\r
166 \r
167 o gnus-offline-before-online-hook\r
168     Hook before all online jobs.\r
169 \r
170 o gnus-offline-after-online-hook\r
171     Hook after all online jobs.\r
172 \r
173 o gnus-offline-interval-time\r
174     Interval time to do all online jobs.(minutes)\r
175 \r
176 o gnus-offline-MTA-type\r
177     MTA type to sending mail.\r
178 \r
179    'smtp     ... Use smtp.el.\r
180    'sendmail ... Use sendmail.el.\r
181 \r
182 o gnus-offline-drafts-queue-type\r
183    Message queue type when spooling message.\r
184    \r
185    'miee  ... Use miee.el.\r
186    'agent ... Use gnus-agent.el.\r
187 \r
188 o gnus-offline-after-empting-spool-hook\r
189    Hook before empting spool.\r
190 \r
191 o gnus-offline-before-empting-spool-hook\r
192    Hook after emoting spool.\r
193 \r
194 o gnus-offline-dialup-function\r
195    Function to dialup.\r
196 \r
197 o gnus-offline-hangup-function\r
198    Function to hangup.\r
199 \r
200 o gnus-offline-pop-password-file \r
201    File name to save username , mailserver and password.\r
202 \r
203 o gnus-offline-pop-password-decoding-function \r
204    Function to decode password.\r
205 \r
206 5) Commands in gnus-offline\r
207 ===========================\r
208 \r
209 o M-x gnus-offline-toggle-plugged\r
210    Toggle offline/online state.\r
211 \r
212 o M-x gnus-offline-toggle-auto-hangup\r
213    Change current state to offline.\r
214 \r
215 o M-x gnus-offline-toggle-on/off-send-mail\r
216    Toggle method to sending mail.\r
217 \r
218 o M-x gnus-offline-toggle-articles-to-fetch\r
219    Toggle articles you want to fetch.\r
220 \r
221 o M-x gnus-offline-toggle-movemail-program\r
222    Toggle movemail program.\r
223 \r
224 o M-x gnus-offline-set-interval-time\r
225    Set interval time(minute) to fetch article.\r
226 \r
227 o M-x gnus-offline-agent-expire\r
228    Expire articles.\r
229 \r
230 6) [!!!IMPORTANT!!!] About the pop password\r
231 ===========================================\r
232 \r
233 <<<<<ATTENTION!!>>>>>\r
234 T-gnus 6.10.56 or later doesn't contain "pop3-fma.el". If you are\r
235 updating to T-gnus 6.10.56 or later, remove the setting for\r
236 pop3-fma.el (or simply, delete the old ~/.gnus-offline.el).\r
237 \r
238 Under Semi-gnus with pop3-fma.el, you must enter the password for the\r
239 pop server every time you accesses the server. (We recommend you do\r
240 it.)\r
241 \r
242 If your machine is stand alone, and nobody else uses it, you can save\r
243 the password in some ways. (But, on your own responsibility!)\r
244 \r
245 ---\r
246 \r
247 One way is provided by gnus-ofsetup.el. At the first interactive\r
248 configuration, it will ask you whether to save the password in\r
249 ~/.newsrc.eld or not. When you answer "y" to this question, the\r
250 password will be saved in ~/.newsrc.eld. (*)\r
251 \r
252        (*) Actually the following will be added to ~/.gnus-offline.el.\r
253 \r
254            [Semi-gnus with pop3-fma.el]\r
255 \r
256             (add-hook 'gnus-setup-news-hook \r
257              (lambda ()\r
258               (add-to-list 'gnus-variable-list 'pop3-fma-password)))\r
259 \r
260            [T-gnus 6.10.56 or later]\r
261 \r
262             (add-hook 'gnus-setup-news-hook \r
263              (lambda ()\r
264               (add-to-list 'gnus-variable-list 'mail-source-password-cache)))\r
265 \r
266 Answer this question carefully, because the password will NOT be\r
267 encoded!\r
268 \r
269 ---\r
270 \r
271 There is another way. It will not save the password in a file but keep\r
272 it in the memory as a variable.\r
273 \r
274 For Semi-gnus with pop3-fma.el, add the following code in\r
275 ~/.gnus-offline.el.\r
276 \r
277          (setq pop3-fma-save-password-information t)\r
278 \r
279 In this way, Once you enter the password at the startup of Gnus, it\r
280 will be kept as a variable `pop3-fma-password' until you quit Gnus.\r
281 \r
282 Under T-gnus 6.10.56 or later, the password will be kept as a variable\r
283 `mail-source-password-cache' by default.\r