Merge changes on t-gnus-6_15-quimby branch.
[elisp/gnus.git-] / README-offline.en
index cd36cff..65af7ee 100644 (file)
-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
+1) What's "gnus-offline (Gnus Offline Backend Utility)" ?
+=========================================================
+
+This program is a utility for T-gnus that handles messages
+(i.e. mail and news) in the "offline" state in a more simple way.
+
+It is basically designed for "gnus-agent". (See info about gnus-agent.)
+
+You can also use it with a function "nnspool"(*1) (which needs an
+external program such as "gnspool"(*2) ), or with "miee.el"(*3) for
+posting and/or sending messages.
+
+     (*1) See info about nnspool.
+     (*2) gnspool comes with a newsreader "gn".
+     (*3) The latest version of miee.el (or MIEE) is available at
+          http://www.shiojiri.ne.jp/%7Et-ichi/meadow.html
+
+You can handle messages in the offline state without "gnus-offline",
+but "gnus-offline" provides a simple way for setup and operation.
+
+**Features**
+
+o Simple configuration -- An "INTERACTIVE" configuration to set
+         the variables.
+
+o Simple operation -- Type "g" in the *Group* buffer, and gnus-offline
+         will:
+           o Dial (*)
+           o Send mails & post news articles
+           o Fetch new mails & articles
+           o Hang up (*)
+
+      (*) For dialing and hanging up, external softwares are needed.
+          But you can do without ones if you connect and disconnect
+          manually.
+
+This document is written mainly for the case using "gnus-agent" with
+gnus-offline.el bundled in T-gnus 6.12.0 or later.
+
+2) Installation
+===============
+
+As you are reading this document, this version of T-gnus includes
+gnus-offline. Installation is simple. "make install" will
+automatically install "gnus-offline".
+
+3) How to use
+=============
+
+o First, you must do a general setup for T-gnus (See info about the
+  setup).
+
+o Add the following code to ~/.emacs
+
+        (autoload 'gnus-plugged "gnus-agent" nil t)
+        (autoload 'gnus-unplugged "gnus-agent" nil t)
+
+o Add the following code to ~/.emacs
+
+       (load "gnus-ofsetup")
+       (gnus-setup-for-offline)
+
+o Add the following code to ~/.gnus
+
+       (gnus-agentize)
+
+o Restart Emacs. gnus-ofsetup.el will ask you some questions and
+ create ~/.gnus-offline.el. (*)
+
+      (*) If you don't know how to answer some questions, typing "TAB"
+          key may show you the possible answers. See the next section
+          which explains the user options.
+          You will also be asked whether to save the POP password in
+          ~/.newsrc.eld or not. Answer it carefully. See section 6)
+          for details.
+
+o At the first time, you must start Gnus in the online state
+ (by M-x gnus-plugged) and decide which groups to subscribe (See info
+ about subscribing).
+
+ From now on you can start Gnus as an offline reader by M-x gnus-unplugged.
+ Try typing "g" in the *Group* buffer.
+
+o You may want M-x gnus to start Gnus as an offline reader as
+ M-x gnus-unplugged. Then write the following code to ~/.emacs
+
+       (setq gnus-plugged nil)
+
+ you can put it into ~/.gnus if there's no need to start Gnus as an online
+ reader (by M-x gnus-plugged).
+
+4) User customizable 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 immediately.
+
+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-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.
+
+5) 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-set-interval-time
+   Set interval time(minute) to fetch article.
+
+o M-x gnus-offline-agent-expire
+   Expire articles.
+
+6) [!!!IMPORTANT!!!] About the pop password
+===========================================
+
+If your machine is stand alone, and nobody else uses it, you can save
+the password. (But, on your own responsibility!)
+
+At the first interactive configuration, it will ask you whether to
+save the password in ~/.newsrc.eld or not. When you answer "y" to this
+question, the password will be saved in ~/.newsrc.eld. (*)
+
+       (*) Actually the following will be added to ~/.gnus-offline.el.
+
+           (add-hook
+            'gnus-setup-news-hook
+            (lambda ()
+              (add-to-list 'gnus-variable-list 'mail-source-password-cache)))
+
+Answer this question carefully, because the password will NOT be
+encoded!