---------------------------------------------------------------------------
ONLINE README.ja
---------------------------------------------------------------------------
online.el --- A elisp program to monitor reachability of the servers.
---------------------------------------------------------------------------

概略
----

このプログラムは TCP 接続要求時にそれがたとえオフライン状態で失敗する
ことがあっても比較的短い応答時間を保証し、また、サーバが接続できるかど
うかの比較的最近確認された状態をチェックする手段を提供するものです。ま
た状態がオンラインとオフライン間で変化した時に自動的にLISP関数を実行す
るためのフックが使えます。これはモードラインの表示を変えたり、オフライ
ン時に行った仕事を自動的に同期させる等に使用できます。 それ以外にも以
下のような機能が用意されています。

  o モードラインの表示を変える関数自体 
  o 統計情報を取り表示する 


動作が確認されている Emacs & バージョンおよび OS 環境 
-----------------------------------------------------

  o GNU Emacs 20.6 / FreeBSD 3.4 (166MHz Pentium) 
  o Meadow 1.10 / Windows NT (366MHz Pentium II) 
  o Meadow 1.14 / Windows 2000 (400Hz Celaron)
  o Mule 2.3 on GNU Emacs 19.34 / FreeBSD 3.4 (166MHz Pentium) 

その他の情報、使用法等
----------------------

インストールするには、 online.el を load-path の通っているディレクトリ
にコピーします。(バイトコンパイルをしたければ行ってください。) 一応 
make (Unix系) または makeit.bat (Windows系) でコンパイルインストールす
ることもできます。make の場合 Makefile の EMACS および INSTALLDIR を環
境にあわせて書き換え make install を実行します。 makeit.bat の場合
makeit.bat を %HOME%/.elispmk などにコピーし、必要な環境変数(PREFIX,
EMACS, EXEC_PREFIX, LISPDIR, INFODIR, VERSION_SPECIFIC_LISPDIR )を設定
したあと./makeit.bat install を実行します。makeit.bat のファイルの先頭
にもう少し詳しい説明があるので参照してください。

基本的な open-network-stream の拡張機能を使用するためには単にこのモジュー
ルをロードするだけです。.emacs ファイルから:

  (load "online")

などとすればOKです。 

オプションを変更するのにカスタマイズが使用できます。このモジュールをロー
ドした後 M-x customize-group としグループ名として online を入力すると 
online.el のオプション変数がリストされます。

モードラインに状態表示を行いたい時には、online-display-status-servers 
にサーバ文字列をリストして online.el をロードしなおします。例えば

  (setq online-display-status-servers '("mail.ml-search.com"))
  (load "online")

とするとモードラインに [*] (オンライン状態) または [-] (オフライン状態) 
が表示されます。([?] だとまだチェックしていない初期状態です。)リストに
サーバが複数ある場合はサーバ順に１文字づつステータスが表示されます。例
えば 4 サーバがリストされている場合3 番目のサーバだけが到達可能な場合
は [--*-] とと表示されます。

下は M-x online-report-stats の出力のスナップショットです。 

-------------------------------------------------------------------------
Server                     status   max  min  ave atmpt  succ  +hit  -hit
-------------------------- ------- ---- ---- ---- ----- ----- ----- -----
localhost                : online     2    2    2     1     1     0     0
mail.ml-search.com       : online   371  326  353     3     3     0     2
www.ml-search.com        : online  1217  399  808     2     2     0     0


Ping process invoke time (msec):     12
Ping process attempt count:          22
-------------------------------------------------------------------------

その他の説明(設計ノート等)が online.el の先頭部分にありますので参照し
てください。


問題点等
--------

スピードの遅い回線でダウンロードとかをおこなっている場合 ping が返って
こない場合にオフライン状態になってしまうことがあります。ダウンロードが
終ってしばらくするとオンライン状態になりますし、タイマ値を適宜調節すれ
ば、この状態になる頻度もへらせるので特に問題はないですが、もう少し改良
の余地は残されています。
