ep, a Simple Text Formatter

ep.el Version 2.1 Tue Jun 18 18:43:44 1996

難波清一 (C) 1994, 1995 S.Namba (GBC00441@niftyserve.or.jp)

概要

ep は、Emacs Lisp で書いた簡易テキストフォーマッタです。

TeX 使ってもいいんだけどちょっと大袈裟すぎるなあ、というような文書は結構あると思います。

たとえば、数枚程度の fax 原稿など、いちいち TeX かけるのは面倒です。そんな文書のフォーマットに使ってみてください。

Mule 2.2.2, 2.3, Nemacs 3.3.2, Demacs 1.2.0 で動作を確認しています。 Mule/Nemacs の機能に依存していない筈なので、Vanilla の Emacs でも使えるでしょう。

高機能ではありませんが、次のような特徴があります。

preview できる（emacs バッファに出力される）。
DOS 風のテキストファイル（パラグラフの終りのみ \n）に対応。
もちろん、UNIX 風のテキストファイル（各行末に \n）にも対応。
日本語、欧文を選ばない（Mule/Nemacs を使う場合）。
プログラムソースファイルに、ヘッダ、行番号のみ付けるという使い方も可能。
フォーマットした、あるいは未フォーマットの出力を PostScript に変換し、あるいはさらに mgetty+sendfax で送信するための fax.el が付属。
アンダーラインなどのプリンタコントロールシーケンスをサポート（デフォルトでは NEC PCPR シリーズで使える数種類のみをサポート）。
プリンタコントロールシーケンスの追加、変更が容易。
プリンタコントロールシーケンスを除き、文書ファイルに整形を制御するための命令やコードを書かずに済む。また、必要ならプリンタコントロールシーケンスを削除して、完全な「テキストファイル」を作成することもできる。
バージョン 19.xx ベースの Emacs, Mule (2.0 以上) では、アンダーラインなどのプリンタコントロールシーケンスの face 表示が可能。
移植性が高い（GNU emacs があれば、どこでも使える）。
数種の英文用「スタイル」ファイル付属。

整形の一例を示します（５行おきの行番号、ヘッダつき、右側は切断）。

=-------- cut -------- cut -------- cut -------- cut --------=
                                                              
        Sat Jul 22 23:40:41 1995 README.1st                   
                                                              
                                                              
                                                              
        ---------------------                                 
        README.1st for ep 1.5                                 
        ---------------------                                 
                                                              
   5    ep は、Emacs Lisp で書いた簡易テキストフォーマッタです
                                                              
        TeX 使ってもいいんだけど、ちょっと大袈裟すぎるなあ、と
        文書のフォーマットに使ってみてください。              
                                                              
  10    Mule 2.2.2, Nemacs 3.3.2, Demacs 1.2.0 で動作を確認し 
        Mule/Nemacs の機能に依存していないはずなので、Vanilla
        でも大丈夫でしょう。DOS の Mule はちょっとわかりません
        はないかと思います。                                  
                                                              
  15    高機能ではありませんが、次のような特徴があります。    
                                                              
                ・アンダーラインなどのプリンタコントロールシー
=-------- cut -------- cut -------- cut -------- cut --------=

コピー、転載、その他はご自由にどうぞ。

それではお楽しみください。

難波清一＠東京保谷市
GBC00441@niftyserve.or.jp

インストール

`ep.el' その他の elisp ファイルを load-path の通ったディレクトリにコピーし、`.emacs' （dos の場合、`_emacs'）に

(autoload 'ep-buffer	"ep" nil t)
(autoload 'ep-region	"ep" nil t)
(autoload 'ep-make-plain-text-buffer	"ep" nil t)

を追加してください。今すぐ使ってみたいたい場合には、上の３つの式の行末に移動し、それぞれ C-x C-e (eval-last-sexp) してください。

elisp ファイルのバイトコンパイルと、コピーには、付属の Makefile を使えます。

$ make

と、引数なしで起動すると、簡単な help を出力します。デフォルトでは、

LISPDIR=$(HOME)/elisp BINDIR=$(HOME)/bin EMACS=emacs

が設定してありますので、これらのパラメータを適宜調整してください。 UNIXでは、

$ make EMACS=mule LISPDIR=~/mylisp install

などとしてください（`~/mylisp' にインストールする場合）。MSDOS の場合、

C:>make LISPDIR=~/elisp INSTALL=xcopy install

などとすると良いでしょう。

また、MSDOS 以外のシステムで、V18 起源の Emacs (Nemacs 3.3.2, Mule 1.x など) を使用する（こともある）場合には、付属の `ep-ctime' コマンドをインストールする必要があります（V19ベースの Emacs, たとえば Mule 2.2.2 では不要です）。file-attributes で得たファイルの変更時刻を ctime (3) 形式で得るためのものです。

# make BINDIR=/usr/local/bin install.bin

などととしてください（デフォルトでは、`~/bin' にインストールされます）。余計なバイナリをインストールしたくなければ、後述の「ep-ctime について」の項を参照してください (see section ep-ctime について)。

MSDOSでは `ep-ctime' は不要なはずです（少なくとも Demacs 1.2.0 では。未確認ですが、たぶん最近の Mule でも大丈夫でしょう。 DOS 上の Mule で問題があればお知らせください）。

ep-ctime をコンパイルあるいはインストールできなくても、ヘッダを出力しない、あるいはファイルの変更時刻を使わず現在時刻を用いることにすれば、`ep-ctime' のインストールは必要ありません。（変数 ep-disable-finfo, ep-print-current-time を参照(see section 書式制御変数)）。

文書の整形と印刷

整形

試しに、`ep.doc' をフォーマットしてみましょう。このファイルにはプリンタ依存の書式を含んでいませんのでどんなプリンタでも印刷できる文書が出力されるはずです (1)。

M-x ep-buffer RET

と入力してください。`*ep-buf*' というバッファがポップアップして結果が表示されます（ep は元のバッファを改変しません）。

出力の書式が乱れているような場合は、

ESC ESC (hack-local-variables) RET

として、このファイルの Local Variables を評価した後、もう一度 ep-buffer してみてください

`sample.jp', `sample.txt' というサンプルドキュメントもあります。これもフォーマットしてみましょう。このドキュメントを画面に残しておきたければ、

C-x 4 f sample.jp RET

などとして、`sample.jp' を読み込んで下さい。これらのサンプルドキュメントではフォーマット機能が簡単に説明してあります。フォーマット前の文章がどんな形かを見終ったら、

M-x ep-buffer RET

としてフォーマットします。

このパッケージ内のファイル（`ep.el' などのプログラムも）は、 ep-buffer したときに所期の書式になるように書いてありますので試してみてください。

あまり大きなファイルに対して ep-buffer を起動すると少々時間がかかるかもしれませんが、% 表示が行なわれるので終了タイミングをある程度予想できるでしょう（この % 表示は batch mode などでは行なわれません）。

文書の一部のみ出力させたい場合は、リージョンを指定してから、

M-x ep-region RET

を使って下さい。

印刷その１

lpr-region, lpr-buffer などを使って、`*ep-buf*' の内容をプリンタに送るだけです。現在、ep には部分印刷の機能や、ページ番号指定の機能がありませんので、文書の特定のページのみ印刷したい場合には lpr-region を利用してください。(2)

MSDOS で lpr-region, lpr-buffer などが使えない場合（使えるようなんらかの処置をしていれれば別です）には、`*ep-buf*' に C-x o して、

M-x write-file RET /prn RET

などとすれば良いでしょう（バッファ全部をプリンタに送る場合）。以後、このバッファは（kill-buffer したり、もういちど ep-buffer や ep-region を実行しない限り）`prn' という特殊ファイルと結びついていますから、C-x C-s を行なうごとにプリンタへの出力が行なわれます。

この ep.doc は、Local Variable の設定（後述）により、デフォルトと違う書式になっていますが、`ep.el' に書き込んであるデフォルト設定は、A4 用紙への印字を前提とし、

ファイルの最終変更時刻、ページ番号のヘッダ
トップマージン６行
左マージン半角１４文字
１行の長さ半角５８文字
１ページ２７行（ダブルスペース）
ボトムマージン４行
５行おきに行番号

となっています（ダブルスペースを採用しているので割と変則的かもしれません）。

このような標準設定を変更したい場合、`ep.el' を直接書き換えても良いですが、後述のような方法でカスタマイズが可能です。

改頁には、フォームフィード `^L' を使っており、トップマージン＋行数＋ボトムマージンは適当な値になります（１ページの長さは必ずしも標準的な 66 行にはなりません）。

バッファ中の任意の位置に `^L' を入力する (C-q C-l) ことで強制改ページが可能です。

印刷その２

フォーマット出力は、依然として（ほぼ）テキストファイルです。これを PostScript に変換したり、fax 送信することもできます。

手作業でこれらの出力処理を行なうのも面倒なので、元のプレーンテキストを ep-buffer し（またはそのまま）、PostScript でセーブする、あるいは fax 送信するために `fax.el' を用意しました。

text->PostScript コンバータとしては psconv, fax ツールとしては、 mgetty+sendfax を前提しています。

`fax.el' は、次のような主要コマンドを含みます。

fax-ps バッファを ps に変換して fax 送信します。
fax-ep-ps バッファを ep でフォーマットしてから ps 変換し、fax 送信します。
psconv-buffer バッファを ps に変換しセーブします。
ep-psconv-buffer バッファを ep でフォーマットしてから ps 変換しセーブします。

fax-ps, psconv-buffer は、既に ep-buffer して preview 済みの出力を fax 送信したり、ps 変換するような用途（あるいは ep なんか使えないよ！って）に使えるでしょう。

詳しくは、`fax.el' およびそのドキュメント `readme.fax' をごらんください。

書式のカスタマイズ

ep で文書の書式を制御しているのは、普通の Emacs Lisp の変数です。

ep.el では、書式制御に関係する変数は、 (make-variable-buffer-local) されており、編集バッファごとにローカルな値を持つようにしてあります。

上記を読んで、ああ判った、という方は、この項を飛ばして次の項に進み、変数の説明を見れば、Emacs で通常の変数を設定する全ての方法を用いて、ep を使えると思います。

しかし、ep では、バッファローカルな／バッファローカルでない変数の違いが結構重要なので、少し冗長になりますが、以下では基礎知識に属する部分も含めて説明します。また、ep に特有な `~/.ep' についても説明しますので、elisp に詳しい方も一応、目を通しておいてください。

setq と setq-default

たとえば、ep で１ページの行数を制御する変数は、

ep-lines

１行の文字数を制御する変数は

ep-chars

です。ep の書式を制御する変数は 'ep-' で始まる名前を持っています。他にもいくつか変数があるのですが、それらの詳細については後まわしにし、ここでは変数の設定のしかたを先に説明します。

これらの書式を制御する変数は Emacs の編集バッファごとにローカルな値を持つように `ep.el' で設定されています。

Emacs で変数を設定するには、

(setq ep-lines 52)

のように setq を用いる方法と、

(setq-default ep-lines 52)

のように setq-default を用いる方法の２つがあります。

バッファローカルでない変数に関しては、通常、setq を使っていればよいのですが、ep の書式制御変数のようにバッファローカルに定義された変数では、setq と、setq-default を意識して使い分ける必要があります（mule の file-coding-system を思い出してください）。

上記の setq の場合は、setq を実行したバッファでの変数の値が 52 に設定されるのに対して、setq-default では、まだ生成されていないバッファも含め全てのバッファにおけるその変数のデフォルト値が 52 に設定されます。

したがって、そのバッファでのみ有効な値を設定したい場合には、setq を、それ以降、全てのバッファで有効な値を設定したい場合には、 setq-default を使用します。

~./ep と Local Variables

ep では、書式制御に主として次の手段を用いるようになっています。

初期化ファイル `~/.ep' （MSDOS では、`~/_ep'）このファイルは、`ep.el(c)' が load される時に読み込まれるもので、書式を制御する変数のデフォルト値を設定するために使用します。つまり、普段よく使う書式を記述しておくわけですが、デフォルト値を設定するためにこのファイルでは、添付の `_ep' のように、setq-default 式を用います。
```
(setq-default ep-lines 52) ;１ページの行数
(setq-default ep-chars 68) ;１行の文字数
```
付属の `_ep' には、テンプレートとして、`ep.el' 内で設定しているのと全く同じデフォルト設定が書いてあります（`_ep' は、 MSDOS 以外のシステムでは、`.ep' にリネームしてから使ってください）。ただし、`ep.el' で設定されている初期値をそのまま用いる場合には、必ずしもこのファイルを用意する必要はありません。なお、`~/.ep' で setq を用いると、その setq を実行したバッファ（通常、`ep.el' のロード時に一時的に使われたバッファ）でのローカル値だけが変更されることになってしまいます）。また、変数の設定は、`~/.emacs' に書き込んでも良いのですが、 `~/.ep' で行なうのが管理上、都合が良いかと思われます。
Local Variables いつも同じ書式ばかり使うわけにはいきませんから、個々の文書ごとにファイル書式を設定する手段が必要です。このために、 ep では、Emacs のいわゆる Local Variable の機構をそのまま流用することにしました。よく、ファイルの終りに
```
Local Variable：
fill-columun: 72 
tab-width 4
End:
```
などと書いてある、アレです。このような記述を入れておくと、 ep-lines, ep-chars などの変数が自動的にバッファローカルな変数に変身し、同時にバッファローカルな値にリセットされます。 ep では、書式を制御する変数が `ep.el' で既にバッファローカルな変数として設定されているのですが、この機構を２重に利用しても不都合は起きません。たとえば、`ep.doc' の終りにあるのと同様に、
```
local variable：
ep-lines: 52
ep-chars: 68
end:
```
などと書いておきます（変数名以外の 'local variable：' 'end:' などは、大文字小文字を区別しなくても良いようです）。上記のように書いた場合は、そのファイルを読み込んだバッファで、(setq ep-lines 52) や, (setq ep-chars 68) を実行した時と同じ効果があります。つまり、そのバッファのテキストの整形についてのみ１ページの行数と１行の文字数が変更され、他のバッファに関する ep-lines, ep-chars は変更されません。また、local variable のセクションに書かなかった他の変数については、`ep.el' や `~/.ep' で設定したデフォルト値が用いられることになります。なお、ep は、デフォルトでは、Local Variables:～ファイル終端までの内容は、印刷すべきテキストとしては無視し、`*ep-buf*' バッファに出力しないようになっています。

Local Variables の実例については、このパッケージのドキュメントや、`ep.el' の最後の部分を参照してください。

上記の `~/.ep' と、Local Variables を用いる２つの書式制御の方法、また、その問題点などについては、後でもう一度詳しく説明します (see section Local Variables, `~/.ep' についてもっと)。

書式制御変数

そろそろ書式を制御する変数を説明しましょう。以下に、ep.el で用いられている書式制御のための主要な変数の一覧を示します。

名前                    初期値  意味                    備考
--------------------------------------------------------------
ep-top-margin           6       トップマージン
ep-left-margin          14      左マージン
ep-lines                27      １ページの行数
ep-chars                58      １行の文字数
ep-tab-width            8       タブ幅
ep-bottom-margin        4       ボトムマージン  
ep-start-page           nil     開始ページ               *
ep-end-page             nil     終了ページ               *
ep-user-header          nil     ユーザヘッダ             *
ep-fill-mode            nil     詰め込みモード
ep-enable-paranum       nil     パラグラフ番号の印字     *
ep-disable-pnum         nil     ページ番号印字の禁止
ep-disable-lnum         nil     行番号印字の禁止
ep-disable-dspc         nil     ダブルスペース印字禁止
ep-bottom-pnum          nil     ページ番号をページ下部に
ep-disable-finfo        nil     ヘッダを印刷しない
ep-kinsoku-process      nil     禁則処理しない           *
ep-wait-for-pchange     nil     用紙交換を待つ           *
ep-print-help           nil     ヘルプ表示する           *
ep-j-file               t       unix 風のtext を入力    後述
ep-dos-style-j-file     nil     DOS 風の text を入力    後述
ep-enable-justify       nil     （欧文）右揃え
ep-enable-all-lnum      nil     行番号を１行ごとに      後述
ep-num-width            4                               後述
ep-lnum-to-text         4                               後述
ep-print-current-time   nil     現在時刻をヘッダとする
ep-hack-local-variables-always t 常に Local Variables   後述
                                   を解釈する
ep-do-not-parse-printer-sequence nil printer-sequence   後述
                                     を解釈しない
ep-do-not-erase-local-v-section nil  Local Variables    後述
                                     を削除しない
ep-do-not-display-percentage nil % 表示を禁止する       後述
--------------------------------------------------------------

上記の表のみでほとんどご理解いただけると思いますが、各変数は数値を格納するものと、t または nil の２値を格納する２つのタイプがあります。

初期値の数字は行数か、半角で数えた文字数、t はその変数による制御が有効、nil は無効を示します。これらの変数は、`~/.ep' などに

(setq-default ep-bottom-pnum t)
(setq-default ep-tab-width 8)

と書くことでデフォルト設定を行ないます。個々のファイルの Local Variables セクションに書く場合は、

Local Variables:
ep-bottom-pnum: t
ep-tab-width: 8
end:

などと書きます。もちろん、整形したいバッファで、

ESC ESC (setq ep-tab-width 8) RET

などとしてもかまいません。

Emacs Lisp の場合、数値を要求する変数に t や nil を代入してもその時点ではエラーにはなりませんのでご注意ください。

上記の表でほとんどの変数の意味はご理解いただけると思いますので、以下では変数のうち解説が必要と思われるもの（上記の表で「後述」とした変数）のみにつき説明します。

上記の変数のうち、右側に * を書いてある変数は、宣言のみで対応する機能が実装されていないか、`p.exe' （ファイル`HISTORY'参照）とのコンパチビリティのために宣言されているもので、Emacs 環境では無意味なものです（したがって、現在では、ごらんのようにごく基本的な書式制御変数しか実装されていまん）。

次の２つについては解説が必要でしょう。この２つは、対象とするテキストが日本語か欧文かを指定するもので、主としてパラグラフのスペーシングの制御に関係するものです。

ep-j-file 初期値: t
ep-dos-style-j-file 初期値: nil ep-j-file は、パラグラフとパラグラフの間のスペーシングを制御します。ep-j-file が t （デフォルト）の場合は、パラグラフ間を改行を入れず詰めてしまう設定になります。nil の場合は、パラグラフ間の改行を操作しません。 UNIX でよく使用されるテキストファイルのように、１行ごとに改行が入っているものをフォーマットする場合は、このデフォルトの設定のままでＯＫです。 ep-dos-style-j-file は、旧い一太郎（V3 の頃？）の *.jxw ファイルのようにパラグラフの終りでのみ改行する DOS 風のテキストファイルを印字する場合、t にします。ep-dos-style-j-file を t にすると、ep-j-file は自動的に t になります。欧文の場合は（以下、`~/.ep' における例のみ示します）、
```
(setq-default ep-dos-style-j-file nil)
(setq-default ep-j-file nil)
```
と明示的に両方とも nil にして下さい。欧文で、
```
(setq-default ep-disable-dspc t)
```
とすると、シングルスペースになりますが、この形式ではパラグラフの終りに改行を２つ入れるようにしたほうが見栄えが良いでしょう。前述のように、初期状態では、日本語、欧文ともに、 ep-disable-dspc は t で、ダブルスペース印字がデフォルトです。

引き続き他の変数についても説明します。

ep-fill-mode 初期値: nil non-nil で詰め込みモードを選択します。変数 ep-chars の値を fill-column として、パラグラフを fill します。
ep-enable-justify 初期値: nil non-nil にすると、英文の場合、詰め込みモード（ep-fill-mode: t）において右揃えを行ないます。emacs に元々備わっている機能を利用しています。日本語の場合には無意味です。右揃えの工程は結構重たい処理なので処理速度はかなり低下します。デフォルトは nil です。
ep-enable-all-lnum 初期値: nil 全部の行に行番号を付与します。デフォルトは nil です。
ep-disable-lnum 初期値: nil 行番号の付与を禁止します。
ep-print-current-time 初期値: nil デフォルトは nil で、ヘッダとしてファイルの変更時刻を用いる設定となっていますが、non-nil にすると、現在時刻を用います。ただし、ディスクファイルと関係のないテキストバッファをフォーマットしており、かつヘッダ印刷を指定している場合には、この変数の値と係りなく、常に現在時刻が用いられます。
ep-hack-local-variables-always 初期値: t t （デフォルト）、常にフォーマット直前に Local Variables セクションを解釈します。デフォルトは t です(see section Local Variables, `~/.ep' についてもっと)。
ep-do-not-parse-printer-sequence 初期値: nil t にしておくことで、ファイル全体についてプリンタコントロールシーケンスを解釈しないようになります。アンダースコア、サブスクリプトなどのプリンタコントロールシーケンスを個々にクオートする方法はまだありません(see section プログラムソースなどの印刷)。
ep-do-not-erase-local-v-section 初期値: nil デフォルトでは、Local Variables:～ファイル終端までの内容は、印刷すべきテキストとしては無視し、*ep-buf* バッファに出力しないようになっていますが、この変数をt にしておくと、Local Variables セクションを削除しなくなります。(see section プログラムソースなどの印刷)。
ep-do-not-display-percentage 初期値: nil 処理の進行状況を示す % 表示を禁止します。８～１０ % 程度、処理速度を向上できます。大きなファイルを ep-fill-mode: t で処理するような際に役立つかもしれません。

上記の各変数のうち、ページのジオメトリに関係するものを以下に示します。ここでは、内部的なパラメータも示してあります。なおこれらのうち、

ep-num-width ページ番号、行番号などの数字の幅です。１つの変数で全ての数字の幅を制御しているので、たとえば２ケタ以下に設定したような場合、不都合が出てくるかもしれません。
ep-lnum-to-text 行番号～テキストまでの距離です。

あとは次の図を見ていただけば、だいたいわかっていただけるでしょう。

| /EP-LEFT-MARGIN                                     EP-NUM-WIDTH\  |
|            |                              |  HEADER-TO-PNUM   |   |_
|            |                              |                   |   ||
|             Fri Mar  4 15:13:11 1994 file.c                   0333|
|                                   :                    EP-TOP-MARGIN
|                                                                    |
|......0234..........................................................-
|      |   |                        :                                |
|        \EP-NUM-WIDTH              :                         EP-LINES
|                                   :                                |
|...................................:................................-
|                                                                    |
|                                                     EP-BOTTOM-MARGIN
|                                 1234                               |
|                                 |   |                              -
|                                   \EP-NUM-WIDTH                    |
|                                                                    |
|            |                        EP-CHARS                       |
   \EP-LEFT-MARGIN

@vindex{ep-top-margin} @vindex{ep-left-margin} @vindex{ep-lines} @vindex{ep-chars} @vindex{ep-tab-width} @vindex{ep-bottom-margin} @vindex{ep-start-page} @vindex{ep-end-page} @vindex{ep-user-header} @vindex{ep-fill-mode} @vindex{ep-enable-paranum} @vindex{ep-disable-pnum} @vindex{ep-disable-lnum} @vindex{ep-disable-dspc} @vindex{ep-bottom-pnum} @vindex{ep-disable-finfo} @vindex{ep-kinsoku-process} @vindex{ep-wait-for-pchange} @vindex{ep-print-help} @vindex{ep-dos-style-j-file} @vindex{ep-j-file} @vindex{ep-enable-justify} @vindex{ep-enable-all-lnum} @vindex{ep-num-width} @vindex{ep-lnum-to-text} @vindex{ep-print-current-time} @vindex{ep-do-not-parse-printer-sequence}

プリンタの初期化

プリンタに初期化コマンドを送る必要がある場合には、たとえば、

(setq-default ep-printer-reset-sequence "\e?o1\e?T0\e?G40")

のように ep-printer-reset-sequence にプリンタに送るストリングを設定してください（デフォルトは nil）。\e は ESC を意味します。

同様に、プリント終了後に、プリンタの設定変更を行う必要があれば、

(setq-default ep-printer-restore-sequence "\eA")

のように ep-printer-restore-sequence を設定してください（デフォルトは nil）。

ep-printer-reset-sequence, ep-printer-restore-sequence に設定した文字列は、出力バッファ `*ep-buf*' の先頭と最後にそれぞれ挿入されます。

上記の例は、PCPR エミュレーションモードに設定した CANON A404E, A404GII で行ピッチ制御を行なっているものです。

ep-printer-reset-sequence, ep-printer-restore-sequence はいずれもバッファローカルな変数です。

Hooks

上記の `~/.ep', Local Variables を用いた変数設定のほかに、次の３つの hook を利用する方法があります。

ep-hook ep-buffer または ep-region による整形直前に実行される
ep-load-hook `ep.el(c)' が load される時に実行される
ep-post-hook ep-buffer / ep-region による整形直後に実行される

なお、ep.el(c) のロード時、まず`~/.ep' がロードされ、次に ep-load-hook が実行されます。

これらの hook は、Emacs Lisp の慣習にほぼ沿うものとして実装してあります（後述の `ep-ctime について' の項に１つ実例があります(see section ep-ctime について)）。

使い方は皆さんで考えてみてください。 Local Variables セクションの eval: 式を使うと、かなりいろいろな事ができそうです。

Local Variables, `~/.ep' についてもっと

ep-hack-local-variables-always

現バージョンの ep では、emacs の仕様をできるだけ尊重する方針を採用していますが、例外がひとつあります。それは、Local Variables の部分の解釈のしかたです。

Emacs では、普通、Local Variables の部分は、

	*** 最初にそのファイルがディスクから ***
	*** 読み込まれる時にしか評価されない ***

ようになっています。

したがって、この仕様を遵守することにすると、既存のバッファの Local Variables の部分を編集し、その変更を続く文書の整形に作用させたければ、

	*** kill-buffer してからもう一度そのファ ***
	*** イルを find-file などにより読み込む  ***

などの方法をとるしかなくなってしまいます。

これはあんまりなので、現在、ep は、デフォルト設定ではフォーマット開始直前に、Local Variables を再評価するようになっています。つまり、変数 ep-hack-local-variables-always が t に設定されています(see section 書式制御変数)(3)。

ep-hack-local-variables-always: t の設定が気にいらない、Emacs の標準仕様どおりフォーマット開始直前に Local Variables を再評価しないでもらいたい、という場合には、`~/.ep' に

(setq-default ep-hack-local-variables-always nil)

と書いておいてください。

この設定にしておいた場合でも、必要なら、

ESC ESC (hack-local-variables) RET

とすることで、いつでも Emacs に Local Variables を再評価させることができます。

Local Variables の取り扱い

前述のように、Local Variables 以下の行は、`*ep-buf*' の整形出力では消去されます。

`ep.doc' などでは、本文中の Local Variables の部分が評価されないように TAB を行の先頭に付けていますが、本来は text-mode など特にコメントの形式が無いバッファでは左寄せで行頭にスペースを入れずに書くか、コメントの形式が定まっている c-mode や emacs-lisp-mode においては、それらのモードで有効なコメントの形式で書いておかなければなりません。

また、デフォルト設定では問題がありませんが、 ep-hack-local-variables-always: nil の設定では、 M-x XXX-mode RET を実行してバッファのモードを変更すると、Local Variables セクションでなどで設定したバッファローカルな設定内容が破壊される可能性があります。 ep-hack-local-variables-always: nil の設定では、ファイルの編集に使用するモードはあまり変更しないようにするか、Local Variables セクションに

mode: text

のように明示的に編集モードを書いておいたほうが良いでしょう。

書式制御変数の評価の順序

念のため、Local Variables 評価、`~/.ep' のロード、ep-hook の実行タイミングを整理しておきます。ここでは、`ep.el(c)' を autoload している時の例を示します。

Local Variables 評価
`ep.el(c)' の autoload -> `~/.ep' のロード、ep-load-hook の評価
Local Variables を再評価 (default)
ep-hook の実行（ep-hook が存在すれば実行）
実際の整形処理
ep-post-hook の実行（ep-post-hook が存在すれば実行）

`ep.el' を autoload している場合、1. は整形を対象とするファイルの読み込み時に実行されます。

次に M-x ep-buffer RET, あるいは M-x ep-region RET などの入力に応じて autoload によって 2. が実行され、このとき、`~/.ep' のロード、 ep-load-hook の評価の順で処理が進みます。

3. の Local Variables の再評価は、ep-hack-local-variables-always が t の場合のみ実行されます(default)。その後、 4. の ep-hook（あれば）が実行され、5. の実際の整形処理が行なわれ、最後に ep-post-hook （あれば）が実行されます。

`ep.el(c)' を autoload する方法では、 Local Variables の評価の後に `~/.ep ' が読み込まれますが、前述のように `~/.ep 'を setq-default 式で書いてあれば、Local Variables は破壊されません。

バッファローカルな変数は、バッファごとに値を変えられる利点がある反面、２つの値が存在するためにユーザが混乱しがちな問題があります。変数設定を書き変えたり、いろいろなスタイルファイルを load したりしているうちに設定状態が「わけわか」になってしまうことがあるかもしれません。こんな場合は、そのバッファを C-x k (kill-buffer) してしまうのが簡単かもしれません（C-x C-s (save-buffer) を忘れずに…）。

バッファローカルな変数、グローバルな変数についての違いの詳細に関しては、は、いちど M-x info RET しておくことをお勧めします。Emacs の info だと、Node: File Variables, Node: Locals あたりでしょうか。 Emacs Lisp の info も参考になります。

@vindex{ep-hack-local-variables-always}

コマンドについて

インタラクティブに使用できる（つまり、M-x なんとか、で起動できる）コマンドは、今のところ

ep-buffer
ep-region
ep-make-plain-text-buffer

の３つだけです。ep-buffer は、もう説明しました (see section 文書の整形と印刷)。

ep-region は、現在のリージョンをフォーマットするものです。 ep-buffer も結局はこれを呼び出します。

ep-make-plain-text-buffer は、バッファ内に存在する ep のプリンタコントロールシーケンスを削除して plain text を得るためのものです。ep-buffer などと同様に、別のバッファをポップアップして結果を出力します。このとき、ep のプリンタコントロールシーケンスの削除以外は、なんらフォーマッティングを行ないません。テキストを ep のシーケンスを理解しないプログラムで処理する場合に利用してください（`fax.el' ではこれを利用しています）。

ep-make-plain-text-buffer は、prefix argument を与えると、バッファ内のフォームフィード `^L' も削除し、さらに変数 ep-do-not-erase-local-v-section (default: nil) が non-nil であれば、Local Variables セクションも削除します(see section 書式制御変数)。

@findex{ep-buffer} @findex{ep-region} @findex{ep-make-plain-text-buffer}

スタイルファイル

３つの「スタイルファイル」（中身は elisp です）のサンプルが付属しています。

`ep-epc.el' ヨーロッパ特許明細書の英文用のスタイルファイル
`ep-usa.el' 米国特許出願明細書の英文用のスタイルファイル
`ep-jpn.el' 前述のデフォルト設定と同じ書式のスタイルファイル

`ep-epc.el' および `ep-usa.el' は極めてマイナーな文書フォーマットですが、英文のレポートなどに流用できる形式だと思います。ご自分でスタイルファイルを作成する際の参考にして下さい。

英文用の２つは、ヘッダなし、５行おきの行番号、頁下部（`ep-usa.el'）ないし、頁上部中央（`ep-epc.el'）に頁番号が付きます。A4 サイズを前提としています。

`ep-jpn.el' は、`ep.el' 内に書き込まれた前述のデフォルト設定と同じ内容に書式をリセットするもので、英文用の２つはこの `ep-jpn.el' をロードします。このスタイルファイルで前述のデフォルト設定にリセットできます。なんらかの理由で設定をデフォルトに戻したい場合にも使えます。

これらのスタイルファイルは、

M-x load-file RET ep-epc.el RET

などとして読み込むほか、もちろん、setq で書いてある式を setq-default に変更した上、`~/.ep' にリネームして使用しても構いません。また、これらのスタイルファイルを変数 load-path で示されるにディレクトリに置き、

Local Variables:
eval: (load "ep-epc")
End:

のように Local Variables セクションを利用して読み込むこともできます。

また、いろいろなスタイルで印刷する場合には、

(defun do-ep-usa ()
  (interactive)
  (load "ep-usa")
  (ep-buffer))

などのコマンドを .emacs に登録しておくと便利かも知れません。

ここで、上記の３つのスタイルファイルでは setq-default ではなく、 setq が用いられていることに注意してください。これは、`~/.ep' などで設定したデフォルト値を破壊しないようにするためです。

なお、たまたま入手したスタイルファイルが setq-default で書いてあった、という場合があるかもしれません。これを手直しせずに使うと、 `~/.ep' に書いたデフォルト設定が破壊されてしまいます。

このような場合、再度 M-x load-file RET `~/.ep' RET を手動で実行しても良いようなものですが、整形終了後、`~/.ep' を自動的に読み込むための変数 ep-reload-startup-file-always を用意してあります。常に確実に `~ /.ep' のデフォルト設定に戻るようにしたければ、 `~/.emacs' や `~/.ep' に

(setq-default ep-reload-startup-file-always t)

と書いておけば良いでしょう（まあ、普通は必要無いでしょう）。

ep-reload-startup-file-always のデフォルト値は、`ep.el' のロード直後では nil です。

@vindex{ep-reload-startup-file-always}

プリンタコントロールシーケンス

アンダースコア、サブスクリプトなどの効果を使えます。

バージョン 19.xx ベースの Emacs, Mule (2.0 以上) では、プリンタコントロールシーケンスを指定したテキスト部分の face 表示が可能です。

また、プリンタコントロールシーケンスの入力をサポートする `ep-seq.el' が付属しています。

これらプリンタコントロールシーケンスの詳細については、readme.seq を参照してください。

プログラムソースなどの印刷

プログラムソースファイルに、ヘッダ、行番号のみ付けるという使いかたも可能です。

`ep.el' の場合、ep に関しては次のような Local Variables 設定を使っています。

;Local Variables:
;ep-enable-all-lnum: t
;ep-left-margin: 3
;ep-lnum-to-text: 1
;ep-num-width: 2
;ep-lines: 50
;ep-hack-local-variables-always: t
;ep-do-not-parse-printer-sequence: t
;ep-do-not-erase-local-v-section: t
;ep-disable-dspc: t
;ep-fill-mode: nil
;ep-dos-style-j-file: nil
;ep-j-file: nil
;End:

ep.el の場合、アンダースコア、サブスクリプトなどのプリンタコントロールシーケンスを解釈しようとすると、エラーになるので、

;ep-do-not-parse-printer-sequence: t

を使っています（アンダースコア、サブスクリプトなどのプリンタコントロールシーケンスを個々にクオートする方法はまだありません。） (see section 書式制御変数)。

また、Local Variables セクションも含め完全な内容を印刷させるために、

;ep-do-not-erase-local-v-section: t

としています(see section 書式制御変数)。

さらに、紙幅を目一杯使うため、ep-left-margin, ep-lnum-to-text, ep-num-width なども調節しています。

ep はどちらかといえば、通常のテキストファイルを対象とするものなので、Local Variables セクションを使ってプログラムソースの印刷を制御しようとすると、上記のように、どうしても冗長になりがちです。

上記と同じ設定を以下のように setq 式で書き、

(setq ep-enable-all-lnum t)
(setq ep-left-margin 3)
(setq ep-lnum-to-text 1)
(setq ep-num-width 2)
(setq ep-lines 50)
(setq ep-hack-local-variables-always t)
(setq ep-do-not-parse-printer-sequence t)
(setq ep-do-not-erase-local-v-section t)
(setq ep-disable-dspc t)
(setq ep-fill-mode nil)
(setq ep-dos-style-j-file nil)
(setq ep-j-file nil)

このファイルを `elisp.ep' という名前で保存し、

Local Variables:
eval: (load-file "./elisp.ep")
end:

などとしても良いでしょう。

バッチモード

Cheap ではありますが、

ep-stdout

という関数があります。ep の出力バッファである `*ep-buf*' の内容を stdout に出力します。

$ mule  -batch -user USER -find-file FILE -f ep-buffer -f ep-stdout \
         2>/dev/null | coco '*autoconv*' '*junet*'

などのように使えます。Mule の場合、`*internal*' な coding system で出力されるので、上記のように coco が必要です。

mule の起動があるので、sh スクリプトとしてはかなりヘビーなものですが…何かの役にはたつでしょう。

Nemacs など、V18 ベースの Emacs では、stdout と stderr を明確に区別していないようなので、ep-stdout は使いものにならないかもしれません。

V18 ベースの Emacs では、`*ep-buf*' に switch-to-buffer して、ファイルにセーブするような関数を書き、バッチモードから呼び出す方が得策でしょう（sh スクリプトからは、Nemacs などの軽い Emacsをぜひ使いたいのですが…）。

@findex{ep-stdout}

サポートパッケージ

上記の「スタイルファイル」

`ep-epc.el'
`ep-usa.el'
`ep-jpn.el'

の他、

`ep-seq.el' プリンタコントロールシーケンスの入力サポートのためのもの
`ep-19.el' プリンタコントロールシーケンスの face 表示を行なうもの
`fax.el' fax 送信のため、フォーマット出力を PostScript に変換し、あるいはさらに送信まで行なうためのもの

が付属しています。

`ep-epc.el', `ep-usa.el', `ep-jpn.el' については、上の「スタイルファイル」の節を参照してください(see section スタイルファイル)。

`ep-seq.el', `ep-19.el' については、`readme.seq' を参照してください。 `fax.el' については、`readme.fax' を参照してください。

`ep-seq.el', `ep-19.el', `fax.el' は、まだあまり形になっていないかもしれません。まあ、オマケ程度に考えてください。

ep-ctime について

Nemacs や mule 1.x など V18 ベースの Emacs を使っているが、余計なバイナリをインストールするのが嫌だ、という場合は `~/.emacs' などで、ep-load-hook を次のように設定しておくと良いでしょう。

(setq ep-load-hook
 '(lambda ()
    (defun ep-file-mtime (fn)
      (let ((tbuf (renew-buffer " *ep-tmp*")))
        (save-excursion
          (set-buffer tbuf)
          (shell-command 
           (format
    "diff -ca %s /dev/null | sed -e 's/^.\*\t//' -e 1q" fn) t)
          (buffer-substring (point-min) (1- (point-max))))))
    ))

ちと遅いかもしれませんが、なんとか使えるでしょう。もう少し速い sh スクリプトがあるでしょうか…。

バグ

現バージョンでは、以下のような不都合があります。

アンダースコア、サブスクリプトなどのプリンタコントロールシーケンスを個々にクオートする方法がまだありません。 ep-do-not-parse-printer-sequence を t にして、ファイル全体についてプリンタコントロールシーケンスの解釈を禁止することができるだけです。）`readme.seq' を参照してください。
詰め込みモードが不自由です。ページ記述言語の如きものを実装しない限り、この制約は将来も付き纏うでしょう。詰め込みモードの場合、文書の一部のみフォーマットを変更する方法がありません。たとえば、詰め込みモードを選択している場合、文書の一部のみ詰め込まないようしたり、インデントを作ったりする方法がありません。表などを作る場合には、改行の数などにより調節してください。
前述のように、対応する変数のみが宣言され、本体が実装されていない機能がいくつかあります。
改頁コードを `^L' 以外に設定できてもあまり嬉しくないように思いましたので、`^L' はプログラムコード中にハードコーディングされています。また、改頁コードを用いずに１ページを画成することができません。
多重にネストしたプリンタコントロールシーケンス、あるいは隣接した複数の異なるプリンタコントロールシーケンスが正しく印字されないかもしれません。私はいつもアンダースコアぐらいしか使いませんので、テストが不十分です。
デフォルトでは、PCPR のプリンタコントロールシーケンスしかサポートしていません。私が PCPR 系にしかアクセスできないためです。ESC/P などのデータを送っていただけると配布に含めることができることができるかもしれません。
face サポートが温泉旅館の別館みたいになってます。たとえば、変数 ep-printer-ctrl-seq-dict は、もっと face と親和性のある構造にすることができるかもしれない、と思っています。
Local Variables を利用すること自体が間違いではないか、という話もあります。Local Variables の機構は、ユーザから見ると極めて便利な機構なのですが、セキュリティに関して少々問題があります（ eval 式を使えるために elisp で可能な事はほとんど全て実行できてしまいます）。セキュリティ上の理由から常時
```
(setq inhibit-local-variables t)
```
にしておかなければならないような環境では、残念ながら、満足に ep を使えないかもしれません。最近の Emacs では、Local Variables に eval が含まれていると、これを評価するかどうか尋ねるようにはなっていますけれども…。

以上のように、現バージョンは Emacs に最初からある編集機能や、変数の設定機構のみを利用したものであり、わずかにプリンタコントロールシーケンスを設定する仕掛けがあるだけで、ページ記述言語のようなものを実装していおらず、極めて低機能です（将来もたぶんそのような大がかりな機構を実装することは無いでしょう）が、日常的な簡単な文書のフォーマットには使えると思います。気にいっていただければ幸いです。

難波清一＠東京保谷市
GBC00441@niftyserve.or.jp

索引

Variable Index

Function Index

Concept Index

e