diff conf/doc/ja-mhook.rf @ 0:bce86c4163a3

Initial revision
author kono
date Mon, 18 Apr 2005 23:46:02 +0900
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/conf/doc/ja-mhook.rf	Mon Apr 18 23:46:02 2005 +0900
@@ -0,0 +1,101 @@
+.\"	@(MHWARNING)
+.\"		written by MH-plus project
+.SC MHOOK 1
+.NA
+mhook, rcvdist, rcvpack, rcvtty  \- MH の受信メールのフック機能
+.SY
+.na
+.ti .5i
+@(MHETCPATH)/rcvdist
+\%[\-form\ formfile]
+\%[switches\ for\ \fIpostproc\fR]
+address\ ...
+\%[\-help]
+
+.ti .5i
+@(MHETCPATH)/rcvpack
+file
+\%[\-help]
+
+.ti .5i
+@(MHETCPATH)/rcvtty
+\%[command]
+\%[\-form\ formatfile]
+\%[\-format\ string]
+\%[\-bell] \%[\-nobell]
+\%[\-newline] \%[\-nonewline]
+\%[\-biff]
+\%[\-help]
+.ad
+.DE
+受信メールフックとは、メールを受けとる毎に走らせるプログラムです。
+これらを手動で起動するのではなくて、システムのメッセージ配送エージェント
+(MTA) が代わりに起動します。どのようにシステムで受信メールフックが作動するかに
+ついて、詳しくは \fIslocal\fP\0(1) を参照して下さい。
+
+\fIMH\fP として、四つのプログラムが現在利用可能です。
+\fIrcvdist\fR (メッセージを追加アドレスに再配布する)、
+\fIrcvpack\fR (送られてきたメッセージを \fIpackf\fR されたファイルに保存する)、
+\fIrcvtty\fR  (メッセージが送られてきたことをユーザーに通知する) です。
+四つめのプログラム、\fIrcvstore\fR\0(1) については別個に説明します。
+これらは全て \fI@(MHETCPATH)/\fR ディレクトリにあります。
+
+\fIrcvdist\fR プログラムは、コマンドラインに書かれているアドレス全てに
+メッセージのコピーを再配布します。
+\fImh\-format\fR\0(5) に書かれているフォーマット文字列機能を使います。
+加えて、\fIrcvdist\fP は以下の付加的なコンポーネント・エスケープも
+認識します。
+.sp 1
+.ne 5
+.nf
+.ta \w'Dtimenow  'u +\w'Returns  'u
+\fIエスケープ\fR	\fI戻り値\fR	\fI説明\fR
+addresses	string	再配布するアドレス
+.re
+.fi
+
+\fIrcvpack\fR は、コマンドラインに書かれているメッセージのコピーを
+追加します。
+この方法は、\fIslocal\fR の \*(lqfile\*(rq アクションに取って変わられています。
+
+\fIrcvtty\fR は、メッセージで指定されたファイルを標準入力として扱い、
+そして端末に結果を出力します。
+
+ファイルが特定されていない、もしくは存在しないものだった、とかの場合、
+\fIrcvtty\fR は代わりに一行スキャン表示をします。
+デフォルトの出力形式を置き換えるには、
+`\-form\ file' または `\-format\ string' オプションが使えます。
+(\fImh\-format\fP\0(5) 参照)。
+メッセージが出力される前に改行が一つ出力され、
+出力終了後に端末ベルが鳴らされます。
+`\-nonewline' と `\-nobell' オプションは、これらの機能を抑制します。
+
+標準の \fImh\-format\fR\0(5) エスケープに追加して、
+\fIrcvtty\fR は下記の付加的コンポーネント・エスケープも認識します。
+.sp 1
+.ne 5
+.nf
+.ta \w'Dtimenow  'u +\w'Returns  'u
+\fIエスケープ\fR	\fI戻り値\fR	\fI説明\fR
+body	string	ボディの(スペースを縮めた)最初の部分
+dtimenow	date	現在時刻
+folder	string	カレント・フォルダ名
+.re
+.fi
+
+通常 \fIrcvtty\fP は、\fImesg\fP\0(1) によって許可された
+書き込み権限に従います。
+`\-biff' を与えると、\fIrcvtty\fP は代わりに、 \fIbiff\fP\0(1) で
+指定された通知ステータスに従います。
+もし、terminal access daemon (TTYD) が利用できるなら、
+\fIrcvtty\fR は、ユーザー端末に書く代わりに、出力するために daemon へ
+出力を送ります。
+.Fi
+^@(MHETCPATH)/mtstailor~^テイラー・ファイル
+^$HOME/\&.maildelivery~^ローカル配送を制御するファイル
+^@(MHETCPATH)/maildelivery~^標準のファイルに代わる
+.Sa
+rcvstore (1), mh\-format(5), slocal(1)
+.Bu
+たった二つのリターンコードだけが意味があります。他もそうあるべきです。
+.En