1999-02-08 Tatsuya Ichikawa <t-ichi@po.shiojiri.ne.jp>
[elisp/gnus.git-] / README-offline.en
index 5bf0399..cd36cff 100644 (file)
-1) What's "gnus-offline (Gnus Offline Backend Utility)" ?
-
-This program is a utility to handle messages(mail & news) in "offline"
-status with Semi-gnus in more simple way.
-
-It designed mainly for "gnus-agent".
-
-So, you can use it with function "nnspool" (which needs external
-programs (such as "gnspool")). And also with "Miee.el" (for only
-posting/sending).
-
-;; Of course, you can handle messages in offline status without
-;; "gnus-offline", but using "gnus-offline" provides you a simple way
-;; to setup and operation.
-
-**Features**
-
-o Simple configuration -- An "INTERACTIVE" way to set variables for
-         configuration.
-
-o Simple operation -- Only typing "g" on *Groups* buffer, then "dialing ->
-         sending mails & posting news articles, and fetch new mails &
-         articles -> hang-up line".(For automatic dialing and hang-up, some
-         external software needed.)
-
-So, this document is written for using "gnus-agent",mainly for bundled
-with T-gnus 6.10.56 or later.
-
-2)Installation
-
-If you use "gnus-offline" with "T-gnus", installation is very
-simple. It would automatically install with "T-gnus".
-
-If not, you may byte-compile "gnus-offline.el" and "gnus-ofsetup.el",
-and set load-path.
-
-3) How to use
-
-o First, you must set up general configuration for Semi-gnus.(See info)
-
-o Add following code to your ~/.emacs
-
-       (load "gnus-ofsetup")
-       (gnus-setup-for-offline)
-       (load gnus-offline-setting-file)
-
-o Add following code to your ~/.gnus
-
-       (gnus-agentize)
-
-o Please restart emacs. Then, gnus-ofsetup.el ask you some questions
- (when you don't know how to answer,see next section of this document
- or type "TAB" key for completion) and then gnus-ofsetup.el will creates
- ~/.gnus-offline.el.
-
-o At first time, you must connect "online" status for subscribe
-  group.(See info)
-
-o Add following code to ~/.gnus
-
-       (gnus-agent-toggle-plugged nil)
-
-Then restart Gnus and try to type "g" on *Groups" buffer.
-
-***Note***
-
-In T-gnus 6.10.56 or later,"pop3-fma.el" doesn't need for multiple
-mail-accounts.
-
-<<<<<ATTENTION!!>>>>>
-T-gnus 6.10.56 or later doesn't contain "pop3-fma.el". So if you had
-use T-gnus 6.10.55(or older) and update to 6.10.56(or later), change
-your settings.(most simple way is deleting old ~/.gnus-offline.el.)
-
-[6.10.55 or older]
-o pop3-fma-spool-file-alist 
-\e$B!!!!!!!!\e(B'(
-       ("po:account1@pop-server1" pass) 
-       ("po:account2@pop-server2" pass) 
-       :
-       :
-       ))
-o pop3-fma-movemail-type 
-      use movemail.exe ('exe) or pop3.el('lisp) 
-
-[6.10.56 or later]
-
-o gnus-offline-mail-source 
-       '(
-       (pop :user "manbou" :server "pop.ceres.dti.ne.jp")
-       (pop :user "imp9397" :server "mvb.biglobe.ne.jp")
-        :
-        :
-       )
-
-
-3)User definable variables in gnus-offline
-
-o gnus-offline-dialup-program  
-    Program name to dialup.
-
-o gnus-offline-dialup-program-arguments
-    List of dialup program arguments.
-
-o gnus-offline-hangup-program
-    Program name to hangup.
-
-o gnus-offline-hangup-program-arguments
-    List of hangup program arguments.
-
-o gnus-offline-mail-spool-directory
-    Spool directory for sending mail.
-    This variable is available only using MIEE.
-
-o gnus-offline-news-spool-directory
-    Spool directory for sending news.
-    This variable is available only using MIEE.
-
-o gnus-offline-mail-treat-environ
-    If t , gnus-offline sends mail to spool first.
-    If nil , gnus-offline sends mail immediatry.
-
-o gnus-offline-articles-to-fetch
-    Article type you want to fetch.
-
-       'both ... Fetch both Mail/News.
-       'Mail ... Fetch only Mail.
-       'News ... Fetch only News.
-
-    Default value is both.
-
-o gnus-offline-popup-menu
-    Whether use menu.
-
-o gnus-offline-load-hook
-    Hook before gnus-offline load.
-
-o gnus-offline-before-online-hook
-    Hook before all online jobs.
-
-o gnus-offline-after-online-hook
-    Hook after all online jobs.
-
-o gnus-offline-interval-time
-    Interval time to do all online jobs.(minutes)
-
-o gnus-offline-MTA-type
-    MTA type to sending mail.
-
-   'smtp     ... Use smtp.el.
-   'sendmail ... Use sendmail.el.
-
-o gnus-offline-drafts-queue-type
-   Message queue type when spooling message.
-   
-   'miee  ... Use miee.el.
-   'agent ... Use gnus-agent.el.
-
-o gnus-offline-after-empting-spool-hook
-   Hook before empting spool.
-
-o gnus-offline-before-empting-spool-hook
-   Hook after emoting spool.
-
-o gnus-offline-dialup-function
-   Function to dialup.
-
-o gnus-offline-hangup-function
-   Function to hangup.
-
-o gnus-offline-pop-password-file 
-   File name to save username , mailserver and password.
-
-o gnus-offline-pop-password-decoding-function 
-   Function to decode password.
-
-4)Commands in gnus-offline.
-
-o M-x gnus-offline-toggle-plugged
-   Toggle offline/online state.
-
-o M-x gnus-offline-toggle-auto-hangup
-   Change current state to offline.
-
-o M-x gnus-offline-toggle-on/off-send-mail
-   Toggle method to sending mail.
-
-o M-x gnus-offline-toggle-articles-to-fetch
-   Toggle articles you want to fetch.
-
-o M-x gnus-offline-toggle-movemail-program
-   Toggle movemail program.
-
-o M-x gnus-offline-set-interval-time
-   Set interval time(minute) to fetch article.
-
-o M-x gnus-offline-agent-expire
-   Expire articles.
-
-5)[!!!IMPORTANT!!!] About pop password
-
-<<<<< ATTENTION >>>>>
-T-gnus 6.10.56 or later doesn't contain "pop3-fma.el". So if you had
-use T-gnus 6.10.55 or older, and update to 6.10.56 or later, change
-your configuration.(most simple way is deleting old
-~/.gnus-offline.el.)
-
-In T-gnus 6.10.55 or older, you must enter password for pop server per 
-accesses.(This way is recommended.)
-
-If your machine is stand alone, and nobody but you use it, you can
-save password in some way.(Of course, it is in your responsibility!)
-
-The first way to save password(it is not save in file but in memory as
-variable), add following code in your ~/.gnus-offline.el.
-
-         (setq pop3-fma-save-password-information t)
-
-In this way, you must enter password only at startup of Gnus.
-(In T-gnus 6.10.56 or later, this status is default.)
-
----
-
-The other way (save password in file but not save in memory) is
-following.
-
-o Add following code to ~/.gnus-offline.el
-
-       (setq gnus-offline-pop-password-file "~/.pop.passwd")
-
-o In T-gnus 6.10.56 or later, comment out following code in
-  ~/.gnus-offline.el.
-
-       (require 'read-passwd)
-       (setq mail-source-read-passwd 'read-pw-read-passwd)
-       (add-hook 'gnus-before-startup-hook 'read-pw-set-mail-source-passwd-cache)
-
-o Create password-file (e.g.~/.pop.passwd)
-
-  [T-gnus 6.10.55 or older]
-
-        (setq pop3-fma-password
-        '(("SERVER1" "ACCOUNT1" "PASSWORD1")
-          ("SERVER2" "ACCOUNT2" "PASSWORD2")
-          ............................
-          ))
-
- [T-gnus 6.10.56 or later]
-
-       (setq mail-source-password-cache
-       '(("SERVER1:ACCOUNT1:pop3" .  "PASSWORD1")
-         ("SERVER2:ACCOUNT2:pop3" .  "PASSWORD2")
-                 ............................
-       ))
-
-To prevent accidents, encoding this file with Base64 is recommended.
-For this purpose,
-       M-: (base64-encode-region (point-min) (point-max))
-can be used.
-
-If you don't need encoding, add following code to ~/.gnus-offline.el.
-
-       (setq gnus-offline-pop-password-decoding-function nil)
-       
-But it is so dangerous!!
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-;;; In T-gnus 6.10.57 (or later), gnus-ofsetup.el will ask you whether
-;;; save password to ~/.newsrc.eld or not. When you answer "y" to this
-;;; question, your password might be saved to ~/.newsrc.eld.  But in
-;;; this way, be careful to answer "y", because your saved password is
-;;; NOT encoded!(of course, you can use above way to save password.)
+1) What's "gnus-offline (Gnus Offline Backend Utility)" ?\r
+=========================================================\r
+\r
+This program is a utility for Semi-gnus that handles messages\r
+(i.e. mail and news) in the "offline" state in a more simple way.\r
+\r
+It is basically designed for "gnus-agent". (See info about gnus-agent.)\r
+\r
+You can also use it with a function "nnspool"(*1) (which needs an\r
+external program such as "gnspool"(*2) ), or with "miee.el"(*3) for\r
+posting and/or sending messages.\r
+\r
+     (*1) See info about nnspool.\r
+     (*2) gnspool comes with a newsreader "gn".\r
+     (*3) The latest version of miee.el (or MIEE) is available at\r
+          http://www.shiojiri.ne.jp/%7Et-ichi/meadow.html\r
+\r
+You can handle messages in the offline state without "gnus-offline",\r
+but "gnus-offline" provides a simple way for setup and operation.\r
+\r
+**Features**\r
+\r
+o Simple configuration -- An "INTERACTIVE" configuration to set\r
+         the variables.\r
+\r
+o Simple operation -- Type "g" in the *Group* buffer, and gnus-offline \r
+         will:\r
+           o Dial (*)\r
+           o Send mails & post news articles\r
+           o Fetch new mails & articles\r
+           o Hang up (*)\r
+\r
+      (*) For dialing and hanging up, external softwares are needed.\r
+          But you can do without ones if you connect and disconnect\r
+          manually.\r
+\r
+This document is written mainly for the case using "gnus-agent" with\r
+gnus-offline.el bundled in Semi-gnus. (*)\r
+\r
+      (*) T-gnus is based on the latest test version of Gnus. It is\r
+          called Pterodactyl Gnus or pGnus.\r
+          Most versions of Semi-gnus other than T-gnus are based on\r
+          Gnus version 5.6.xx.\r
+          There are a lot of changes between Gnus 5.6.xx and pGnus.\r
+          This document will refer to the differences caused by the\r
+          changes when it is important.\r
+\r
+2) Installation\r
+===============\r
+\r
+As you are reading this document, this version of Semi-gnus includes\r
+gnus-offline. Installation is simple. "make install" will\r
+automatically install "gnus-offline".\r
+\r
+If the Semi-gnus comes without gnus-offline, or you want to install\r
+the latest version of gnus-offline, you may manually byte-compile\r
+"gnus-offline.el" and "gnus-ofsetup.el". Make sure they are in one of\r
+the `load-path' directories. \r
+\r
+3) How to use\r
+=============\r
+\r
+o First, you must do a general setup for Semi-gnus (See info about the \r
+ setup).\r
+\r
+o Add the following code to ~/.emacs\r
+\r
+       (load "gnus-ofsetup")\r
+       (gnus-setup-for-offline)\r
+       (load gnus-offline-setting-file)\r
+\r
+o Add the following code to ~/.gnus\r
+\r
+       (gnus-agentize)\r
+\r
+o Restart Emacs. gnus-ofsetup.el will ask you some questions and\r
+ create ~/.gnus-offline.el. (*)\r
+\r
+      (*) If you don't know how to answer some questions, typing "TAB"\r
+          key may show you the possible answers. See the next section\r
+          which explains the user options.\r
+          You will also be asked whether to save the POP password in\r
+          ~/.newsrc.eld or not. Answer it carefully. See section 6)\r
+          for details.\r
+\r
+o At the first time, you must start Gnus in the "online" state and\r
+ decide which groups to subscribe (See info about subscribing).\r
+\r
+o Add the following code to ~/.gnus\r
+\r
+       (gnus-agent-toggle-plugged nil)\r
+\r
+That's all. Restart Gnus and try typing "g" in the *Group* buffer.\r
+\r
+***Note***\r
+\r
+Most versions of Semi-gnus have pop3-fma.el to operate multiple POP\r
+accounts. T-gnus 6.10.56 or later does not because it can handle\r
+multiple POP accounts itself.\r
+\r
+<<<<<ATTENTION!!>>>>>\r
+T-gnus 6.10.56 or later doesn't contain "pop3-fma.el". If you are\r
+updating to T-gnus 6.10.56 or later, remove the setting for\r
+pop3-fma.el (or simply, delete the old ~/.gnus-offline.el).\r
+\r
+[Semi-gnus with pop3-fma.el]\r
+o pop3-fma-spool-file-alist \r
+\e$B!!!!!!!!\e(B'(\r
+       ("po:account1@pop-server1" pass) \r
+       ("po:account2@pop-server2" pass) \r
+       :\r
+       :\r
+       ))\r
+o pop3-fma-movemail-type \r
+      use movemail.exe ('exe) or pop3.el('lisp) \r
+\r
+[T-gnus 6.10.56 or later]\r
+\r
+o gnus-offline-mail-source \r
+       '(\r
+       (pop :user "manbou" :server "pop.ceres.dti.ne.jp")\r
+       (pop :user "imp9397" :server "mvb.biglobe.ne.jp")\r
+        :\r
+        :\r
+       ) \r
+\r
+\r
+4) User customizable variables in gnus-offline\r
+==============================================\r
+\r
+o gnus-offline-dialup-program  \r
+    Program name to dialup.\r
+\r
+o gnus-offline-dialup-program-arguments\r
+    List of dialup program arguments.\r
+\r
+o gnus-offline-hangup-program\r
+    Program name to hangup.\r
+\r
+o gnus-offline-hangup-program-arguments\r
+    List of hangup program arguments.\r
+\r
+o gnus-offline-mail-spool-directory\r
+    Spool directory for sending mail.\r
+    This variable is available only using MIEE.\r
+\r
+o gnus-offline-news-spool-directory\r
+    Spool directory for sending news.\r
+    This variable is available only using MIEE.\r
+\r
+o gnus-offline-mail-treat-environ\r
+    If t , gnus-offline sends mail to spool first.\r
+    If nil , gnus-offline sends mail immediately.\r
+\r
+o gnus-offline-articles-to-fetch\r
+    Article type you want to fetch.\r
+\r
+       'both ... Fetch both Mail/News.\r
+       'Mail ... Fetch only Mail.\r
+       'News ... Fetch only News.\r
+\r
+    Default value is both.\r
+\r
+o gnus-offline-load-hook\r
+    Hook before gnus-offline load.\r
+\r
+o gnus-offline-before-online-hook\r
+    Hook before all online jobs.\r
+\r
+o gnus-offline-after-online-hook\r
+    Hook after all online jobs.\r
+\r
+o gnus-offline-interval-time\r
+    Interval time to do all online jobs.(minutes)\r
+\r
+o gnus-offline-MTA-type\r
+    MTA type to sending mail.\r
+\r
+   'smtp     ... Use smtp.el.\r
+   'sendmail ... Use sendmail.el.\r
+\r
+o gnus-offline-drafts-queue-type\r
+   Message queue type when spooling message.\r
+   \r
+   'miee  ... Use miee.el.\r
+   'agent ... Use gnus-agent.el.\r
+\r
+o gnus-offline-after-empting-spool-hook\r
+   Hook before empting spool.\r
+\r
+o gnus-offline-before-empting-spool-hook\r
+   Hook after emoting spool.\r
+\r
+o gnus-offline-dialup-function\r
+   Function to dialup.\r
+\r
+o gnus-offline-hangup-function\r
+   Function to hangup.\r
+\r
+o gnus-offline-pop-password-file \r
+   File name to save username , mailserver and password.\r
+\r
+o gnus-offline-pop-password-decoding-function \r
+   Function to decode password.\r
+\r
+5) Commands in gnus-offline\r
+===========================\r
+\r
+o M-x gnus-offline-toggle-plugged\r
+   Toggle offline/online state.\r
+\r
+o M-x gnus-offline-toggle-auto-hangup\r
+   Change current state to offline.\r
+\r
+o M-x gnus-offline-toggle-on/off-send-mail\r
+   Toggle method to sending mail.\r
+\r
+o M-x gnus-offline-toggle-articles-to-fetch\r
+   Toggle articles you want to fetch.\r
+\r
+o M-x gnus-offline-toggle-movemail-program\r
+   Toggle movemail program.\r
+\r
+o M-x gnus-offline-set-interval-time\r
+   Set interval time(minute) to fetch article.\r
+\r
+o M-x gnus-offline-agent-expire\r
+   Expire articles.\r
+\r
+6) [!!!IMPORTANT!!!] About the pop password\r
+===========================================\r
+\r
+<<<<<ATTENTION!!>>>>>\r
+T-gnus 6.10.56 or later doesn't contain "pop3-fma.el". If you are\r
+updating to T-gnus 6.10.56 or later, remove the setting for\r
+pop3-fma.el (or simply, delete the old ~/.gnus-offline.el).\r
+\r
+Under Semi-gnus with pop3-fma.el, you must enter the password for the\r
+pop server every time you accesses the server. (We recommend you do\r
+it.)\r
+\r
+If your machine is stand alone, and nobody else uses it, you can save\r
+the password in some ways. (But, on your own responsibility!)\r
+\r
+---\r
+\r
+One way is provided by gnus-ofsetup.el. At the first interactive\r
+configuration, it will ask you whether to save the password in\r
+~/.newsrc.eld or not. When you answer "y" to this question, the\r
+password will be saved in ~/.newsrc.eld. (*)\r
+\r
+       (*) Actually the following will be added to ~/.gnus-offline.el.\r
+\r
+           [Semi-gnus with pop3-fma.el]\r
+\r
+            (add-hook 'gnus-setup-news-hook \r
+             (lambda ()\r
+              (add-to-list 'gnus-variable-list 'pop3-fma-password)))\r
+\r
+           [T-gnus 6.10.56 or later]\r
+\r
+            (add-hook 'gnus-setup-news-hook \r
+             (lambda ()\r
+              (add-to-list 'gnus-variable-list 'mail-source-password-cache)))\r
+\r
+Answer this question carefully, because the password will NOT be\r
+encoded!\r
+\r
+---\r
+\r
+There is another way. It will not save the password in a file but keep\r
+it in the memory as a variable.\r
+\r
+For Semi-gnus with pop3-fma.el, add the following code in\r
+~/.gnus-offline.el.\r
+\r
+         (setq pop3-fma-save-password-information t)\r
+\r
+In this way, Once you enter the password at the startup of Gnus, it\r
+will be kept as a variable `pop3-fma-password' until you quit Gnus.\r
+\r
+Under T-gnus 6.10.56 or later, the password will be kept as a variable\r
+`mail-source-password-cache' by default.\r