* gnus-namazu.el (gnus-namazu/truncate-article-list): Remove a redundancy;
[elisp/gnus.git-] / README-offline.en
index 58c379c..65af7ee 100644 (file)
@@ -1,7 +1,98 @@
+1) What's "gnus-offline (Gnus Offline Backend Utility)" ?
+=========================================================
 
-User definable variables in gnus-offline
+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.
 
-o gnus-offline-dialup-program  
+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
@@ -23,7 +114,7 @@ o gnus-offline-news-spool-directory
 
 o gnus-offline-mail-treat-environ
     If t , gnus-offline sends mail to spool first.
-    If nil , gnus-offline sends mail immediatry.
+    If nil , gnus-offline sends mail immediately.
 
 o gnus-offline-articles-to-fetch
     Article type you want to fetch.
@@ -34,9 +125,6 @@ o gnus-offline-articles-to-fetch
 
     Default value is both.
 
-o gnus-offline-popup-menu
-    Whether use menu.
-
 o gnus-offline-load-hook
     Hook before gnus-offline load.
 
@@ -57,7 +145,7 @@ o gnus-offline-MTA-type
 
 o gnus-offline-drafts-queue-type
    Message queue type when spooling message.
-   
+
    'miee  ... Use miee.el.
    'agent ... Use gnus-agent.el.
 
@@ -73,13 +161,8 @@ o gnus-offline-dialup-function
 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.
-
-Commands in gnus-offline.
+5) Commands in gnus-offline
+===========================
 
 o M-x gnus-offline-toggle-plugged
    Toggle offline/online state.
@@ -93,12 +176,28 @@ o M-x gnus-offline-toggle-on/off-send-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.
 
+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!