Update.
[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         (load "gnus-ofsetup")
56         (gnus-setup-for-offline)
57
58 o Add the following code to ~/.gnus
59
60         (gnus-agentize)
61
62 o Restart Emacs. gnus-ofsetup.el will ask you some questions and
63  create ~/.gnus-offline.el. (*)
64
65       (*) If you don't know how to answer some questions, typing "TAB"
66           key may show you the possible answers. See the next section
67           which explains the user options.
68           You will also be asked whether to save the POP password in
69           ~/.newsrc.eld or not. Answer it carefully. See section 6)
70           for details.
71
72 o At the first time, you must start Gnus in the "online" state and
73  decide which groups to subscribe (See info about subscribing).
74
75 o Add the following code to ~/.gnus
76
77         (gnus-agent-toggle-plugged nil)
78
79 That's all. Restart Gnus and try typing "g" in the *Group* buffer.
80
81 4) User customizable variables in gnus-offline
82 ==============================================
83
84 o gnus-offline-dialup-program
85     Program name to dialup.
86
87 o gnus-offline-dialup-program-arguments
88     List of dialup program arguments.
89
90 o gnus-offline-hangup-program
91     Program name to hangup.
92
93 o gnus-offline-hangup-program-arguments
94     List of hangup program arguments.
95
96 o gnus-offline-mail-spool-directory
97     Spool directory for sending mail.
98     This variable is available only using MIEE.
99
100 o gnus-offline-news-spool-directory
101     Spool directory for sending news.
102     This variable is available only using MIEE.
103
104 o gnus-offline-mail-treat-environ
105     If t , gnus-offline sends mail to spool first.
106     If nil , gnus-offline sends mail immediately.
107
108 o gnus-offline-articles-to-fetch
109     Article type you want to fetch.
110
111        'both ... Fetch both Mail/News.
112        'Mail ... Fetch only Mail.
113        'News ... Fetch only News.
114
115     Default value is both.
116
117 o gnus-offline-load-hook
118     Hook before gnus-offline load.
119
120 o gnus-offline-before-online-hook
121     Hook before all online jobs.
122
123 o gnus-offline-after-online-hook
124     Hook after all online jobs.
125
126 o gnus-offline-interval-time
127     Interval time to do all online jobs.(minutes)
128
129 o gnus-offline-MTA-type
130     MTA type to sending mail.
131
132    'smtp     ... Use smtp.el.
133    'sendmail ... Use sendmail.el.
134
135 o gnus-offline-drafts-queue-type
136    Message queue type when spooling message.
137
138    'miee  ... Use miee.el.
139    'agent ... Use gnus-agent.el.
140
141 o gnus-offline-after-empting-spool-hook
142    Hook before empting spool.
143
144 o gnus-offline-before-empting-spool-hook
145    Hook after emoting spool.
146
147 o gnus-offline-dialup-function
148    Function to dialup.
149
150 o gnus-offline-hangup-function
151    Function to hangup.
152
153 5) Commands in gnus-offline
154 ===========================
155
156 o M-x gnus-offline-toggle-plugged
157    Toggle offline/online state.
158
159 o M-x gnus-offline-toggle-auto-hangup
160    Change current state to offline.
161
162 o M-x gnus-offline-toggle-on/off-send-mail
163    Toggle method to sending mail.
164
165 o M-x gnus-offline-toggle-articles-to-fetch
166    Toggle articles you want to fetch.
167
168 o M-x gnus-offline-set-interval-time
169    Set interval time(minute) to fetch article.
170
171 o M-x gnus-offline-agent-expire
172    Expire articles.
173
174 6) [!!!IMPORTANT!!!] About the pop password
175 ===========================================
176
177 If your machine is stand alone, and nobody else uses it, you can save
178 the password. (But, on your own responsibility!)
179
180 At the first interactive configuration, it will ask you whether to
181 save the password in ~/.newsrc.eld or not. When you answer "y" to this
182 question, the password will be saved in ~/.newsrc.eld. (*)
183
184        (*) Actually the following will be added to ~/.gnus-offline.el.
185
186             (add-hook
187              'gnus-setup-news-hook
188              (lambda ()
189                (add-to-list 'gnus-variable-list 'mail-source-password-cache)))
190
191 Answer this question carefully, because the password will NOT be
192 encoded!