= rail*.el ドキュメント

Authors:: Youhei SASAKI <uwabami@gfd-dennou.org>
Date:: $Lastupdate: 2012/06/16 15:25:00$
Copyright:: 1999-2002 しまだみつのぶ.
            2010-2012 Youhei SASAKI
License:: GPL-2+, @see GPL-2[https://raw.github.com/uwabami/rail/master/GPL-2]

== RAIL とは?

RAIL -- Replace Agent-string Internal Library レイルは, 以下の機能を提供しています:

1. tm に含まれる genjis.el 互換機能 (変数 mule-version の日本語化)
2. FLIM / SEMI / XEmacs / UTF-2000 Mule / Meadow のコードネームを
   日本語化し, メッセージの User-Agent: フィールドに適用する
3. irchat-pj で, CTCP VERSION を受けたときに返す文字のうち,
   Mule / XEmacs / Meadow のコードネームを日本語化する
   また, 一部バージョンの Meadow で irchat-pj を利用している場合,
   正しくバージョンが表示できないバグを修正する

== インストール方法

基本的に make install するだけです. make して make install としてもかまいません.

    make EMACS=mule

等のようにすれば, (Emacs)実行ファイルを指定することができます. また, インストール場所を指定したい場合,

    make LISPDIR=/home/simm/site-lisp

等のようにすれば, 指定したパスにインストールされます. デフォルトの site-lisp 直下にインストールしたい場合は

    make LISPDIR=site-lisp

のように, site-lisp を指定ください.

XEmacs のパッケージとしてインストールする場合は

    make install-package

としてください. インストールしたい XEmacs の実行ファイルは

    make XEMACS=xemacs-21.2-b28 install-package

等のようにすることで指定できます. 一般インストールと同じく, make package してから make install-package をしてもかまいません.

MULE のコードネームが増えることはさほどないとは思いますが, FLIM や SEMI は, 随時コードネームが増加しております.
より新しいコードネームを正しく変換するためには,
[FLIM] FLIM(およびその派生形)のソースにある VERSION をcontrib/FLIM_VERSION にコピー
[SEMI] SEMI(およびその派生形)のソースにある VERSION をcontrib/SEMI_VERSION にコピー
したうえで,

  % make distclean
  % make
  # make install

してください. make distclean 直後に make install してもかまいません. また, XEmacs パッケージとして作成する場合は make のかわりに make install-package します.


== 使用方法

~/.emacs のどこかに

    (require 'rail)

と記述しておくだけです. 今まで ISO-8859-4 を使った User-Agent:フィールドが, 日本語表記に変更されます.
irchat-pj の CTCP VERSION の結果も日本語化されます.

また, rail.el は tm に含まれる genjis.el の互換機能も提供します. ~/.emacs の, (require 'rail) の記述の手前に

    (setq rail-emulate-genjis t)

と書いておくことで, 変数 mule-version が日本語化されます.
なお, rail-emulate-genjis が nil であっても User-Agent: に含まれる Mule の codename は日本語表記になります.

User-Agent: はそのままで, genjis 機能だけ利用したい場合は,

    (setq rail-emulate-genjis t
          rail-user-agent-convert-statically  nil
          rail-user-agent-convert-dynamically nil)

とします.

irchat-pj の CTCP VERSION をいじりたくない場合は,

    (setq rail-pj-convert nil)

とします.

コンパイル後に FLIM / SEMI / XEmacs / Meadow のバージョンを増やしたい,コードネームを別の表記にしたい場合等は,

* rail-additional-flim-codename-alist (FLIM)
* rail-additional-semi-codename-alist (SEMI)
* rail-additional-xemacs-codename-alist (XEmacs)
* rail-additional-meadow-codename-alist (Meadow)

を設定してください. 設定方法は, それぞれの additional がつかない変数と同じですので, これらが定義されている rail-table-*.el を参照ください.
なお, こちらで記述したものが優先されますので, デフォルトが気にいらない場合等, これらの変数を設定してください.

== APEL 依存性

基本的に, rail のコードは APEL に依存しておりません. ただ, ほとんどの場合
FLIM や SEMI のコードネーム変換に利用されることでしょうから, そういう意味
では APEL 依存なのかもしれません.

== バージョン番号

rail-1.2.0 のように, "." で区切られた3つの数字でバージョンを表しておりま
す. ふたつめの数字 (上の例だと, 2) が偶数のものが安定バージョン, 奇数のも
のが開発バージョンです.

== 今後の予定

1. XEmacs や Meadow のコードネームデータベースの充実
2. mime-view 対応
3. SEMI 系以外の User-Agent 対応

== 意見・要望等

メールで uwabami@gfd-dennou.org[mailto:uwabami@gfd-dennou.org] までお願いします.

== なんかうまく動かないんですが…

まずは, 付属の FAQ.rdoc[https://raw.github.com/uwabami/rail/master/FAQ.rdoc]に目をとおしてください.
もし FAQ.rdoc[https://raw.github.com/uwabami/rail/master/FAQ.rdoc]にないような現象が起こる場合,
上と同じく, メールで uwabami@gfd-dennou.org[mailto:uwabami@gfd-dennou.org] までお願いします.

== 配布・改変について

このプログラムは free software です. GNU General Public License のもとに,
このプログラムを再配布したり改変したりしてもかまいません.

   This file is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2, or (at your option)
   any later version.

   This file is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with GNU Emacs; see the file COPYING.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth
   Floor, Boston, MA 02110-1301 USA.

== HISTORY

本プログラムは 2002 年までしまだみつひろさんによって開発/管理されていまし
た. 過去の開発履歴は
old/CHANGELOG[https://raw.github.com/uwabami/rail/master/old/CHANGELOG]
にあります. しまださんが開発から手を引かれたので, 2010 年から佐々木がひき
とって細々と公開しています. 有用なプログラムを作成して下さったしまださん
への感謝をここに記しておきます.

本プログラム群は気がついたタイミングで適宜アップデートしていきます. ご意
見や要望などありましたら, 遠慮なくご連絡下さい.

