[README for cmail]

各種外部パッケージ，OS環境などの設定，使用法などは doc/ 以下の
ドキュメントを参照してください．

cmailとは?
==========

cmailは，Emacs 系のエディタ上で動くメイル管理システム，すなわち，ユー
ザのメイルの表示・編集・送信を支援するシステムです。cmailはもともと林 
亮さんによってchain-mailという名前でversion 1.*が作られました。その後，
まつもと ゆきひろさんが大規摸な改造を行なって現在(version 2.*)に至って
います。

インストール
============

標準インストール手順
--------------------

1a) makeを使える環境の場合

% make install EMACS=mule PREFIX=/usr/local

とするだけでOKです。
他に指定可能なオブションはEXEC_PREFIX(現行のcmailでは無視されます),
LISPDIR,INFODIRなどがあります。

1b) makeを使えない環境の場合

makeが使えない環境でも直接Emacsを呼び出せばインストールすること
ができます。

% mule -batch -q -no-site-file -l CMAIL-MK -f install-cmail \
    /usr/local NONE /usr/local/lib/emacs/site-lisp /usr/local/info

オプションはPREFIX,EXEC_PREFIX,LISPDIR,INFODIRの順番で指定して
ください。指定したくない場合NONEを指定すると，そのオプションは
無視されます。

2) tm/SEMIのインストール

cmailでMIMEを使うためにはtm (GNU Emacs 18.xx, 19.xx で使用) やSEMI
(GNU Emacs 20.x, 21.x などで使用) というパッケージを別途インストールす
る必要があります。

http://cvs.m17n.org/elisp/SEMI/
http://cvs.m17n.org/elisp/FLIM/
http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/

などで入手して，インストールしてください。
tmやSEMIなしでcmailを使うこともできますが，あった方が快適な環境
を構築することができます。

tmやSEMIがインストールされていない環境にcmailをインストールした
場合，cmailからtmやSEMIを利用するために必要なファイルがインスト
ールされません。tm/SEMIを使う場合は，tm/SEMIのインストールの後で
cmailをインストールし直してください。

3) Infoの登録

cmailの詳しい使い方は1a)または1b)によってインストールされた
cmail.infoに記載されています。このファイルをEmacsから参照出来
るようにします。

Infoファイルのインストールされたディレクトリ(デフォルトは
/usr/local/info)にあるdirというファイルに、

* cmail: (cmail). cmail reference manual.

のような記述をします。これでM-x infoで読むことが出来るようにな
りました。

NOTE: もし 'install-info' コマンドが使える環境であれば, 'dir' ファイル
をコマンドでアップデートできます. (簡単な使い方は install-info --help
を参照してください.) コマンドは以下のように実行します.

$ install-info --info-dir=INFORDIR INFODIR/cmail.info
$ install-info --info-dir=INFORDIR INFODIR/cmail.en.info

INFODIR は info ディレクトリです。

例えば, もし INFODIR=//c/Meadow/1.14/info であれば, 以下を実行します:

$ install-info --info-dir=//c/Meadow/1.14/info //c/Meadow/1.14/info/cmail.info
$ install-info --info-dir=//c/Meadow/1.14/info //c/Meadow/1.14/info/cmail.en.info

またはINFODIR=/usr/local/info であれば, 以下を実行します:

$ install-info --info-dir=/usr/local/info /usr/local/info/cmail.info
$ install-info --info-dir=/usr/local/info /usr/local/info/cmail.en.info


インストール時の注意点
----------------------

1) APEL

カスタマイズ機能の導入に伴い、バージョン 2.61 から pcustom をサポート
しているバージョンの APEL (A Portable Emacs lisp Library -
http://cvs.m17n.org/elisp/APEL/) が必須となりました。この要求変更にと
もない、インストールに関して以下の注意が必要です。

  o もし既に APEL がインストールされている場合、cmail のみがコンパイル
    インストールされます。

  o もし APEL がインストールされていない場合で、標準インストールを行う
    場合は、cmail のパッケージに添付されている APEL がまずコンパイル/
    インストールされ、その後 cmail 自体がコンパイル/インストールされ
    ます。

    この時 make に渡す PREFIX, EXEC_PREFIX, LISPDIR, INFODIR 等のパラ
    メータは APEL と cmail のインストールの両方で同じものが使用されま
    す。これで不都合がある場合は、apel サブディレクトリに移動してまず
    APEL をインストールし、これがみつかるように subdirs.el 等を調節
    してから、別パラメータを指定して cmail をインストールしてください。

  o もし、標準インストールをせずに load-path を直接 cmail パッケージを
    展開、コンパイルしたディレクトリに指定して使用するような場合、APEL
    がインストールされていない環境では、apel サブディレクトリも
    load-path に指定する必要があります。

  o apel を始めてインストールした場合は subdirs.el または .emacs 等で
    load-path を調節していないと、"Cannot open load file: path-util" 
    等のエラーで起動できない事があります。この場合 load-path に apel
    インストール先のディレクトリを加えてください。
    
また、cmail では custom パッケージで提供されている「カスタマイズ変数値
の変更と同時に必要なモジュールの設定を動的に行うための機能」を一部使用
しています。この機構がサポートされていると変数を変更したあとの再起動を
行う必要がなくなって便利なわけですが、残念ながら、古いバージョンの 
custom ではこれがサポートされていません。また、そのようなバージョンの 
custom がシステムに存在する場合、コンパイル時や cmail 起動時にエラーが
起こることもあります。現在確認されているものでは custom.el のバージョ
ンが 1.15 で Gnus 5.4.1 に付属しているものがこれにあたります。なるべく
動作に支障がでないように工夫してはいますが、完全に動作を保証することは
できません。他のパッケージ(Gnus 等)の動作に影響を与えない範囲でしか対
応ができないからです。どちらにしてもこの中途半端なバージョンの 
custom.el は将来的に問題が発生することはあれ、別段よいこともないと思わ
れますのでなるべく早く最新の custom.el にアップグレードすることをお勧
めします。詳しくは apel/README.ja 内の 「古い custom」と「新しい 
custom」の記述を参考にしてください。


2) インストール先のディレクトリ

バージョン 2.61 から、20.x バージョンベースの Emacs ではインストール先
のディレクトリが 2.60 までのものから変更になり、LISPDIR 以下に "cmail" 
というサブディレクトリを作成するようになりました。これは、2.60 までの 
xemacs と同様の取扱いになります。ただし、2.60 が既にインストールしてあ
る環境では、二重にインストールするのを避けるため、2.60 と同様に 
LISPDIR 以下にフラットにインストールするようになっています。19.x 以前
のバージョンの Emacs の場合は、2.60 までと同様 LISPDIR 以下にサブディ
レクトリを作らずフラットにインストールします。

インストールに先だって何処にインストールされるかを make のターゲットに 
what-where を指定する事によって表示、確認できるようになっています。


インストール後の設定
====================

インストールが済んだら Info を参照の上、必要な変数を .emacs に設定して
ください。Info に最小限必要と思われる設定についての説明があります。

バージョン 20.x の Emacs 等、カスタマイズ機能が使える場合は、

  M-x load-library<CR>
  cmail<CR>

として cmail をロードした後 

  M-x cmail-customize

とする事によりカスタマイズ機能を呼出して、変数の説明を参照しながら設定
を行うことができます。


その他
======

Meadow, Mule for Windows 等の Windows 系 Emacs をご利用の方は、
doc/README.Windows を御一読される事をお勧めします。標準で通常使用され
る外部パッケージのインストールおよびその他の設定の説明があります。
