なつみかん(NATSU-MICAN)

release ver.3.1(20010206)

設定リファレンス

ここでは、「なつみかん」において設定できる項目・および置換指定子について解説します。
「なつみかん」を初めてご利用の方は、先に「スターティングガイド」で動作することを確認してからこちらの設定をすすめて下さい。

nm.phの設定項目については、それぞれの関数ごとの設定にファイルを切り分けて、関数実行の際その設定を呼び出すようにできます。
ただし、「共通設定」、「info.cgi設定」、「nmp.cgi設定」だけはnm.phファイルに記述してください(info.cgi設定、nmp.cgi設定は、これらのCGIを使用しないときは無くても良いです)。

nm.phの設定項目

共通設定

$nm::cf::????の設定値
「共通設定」は、必ずnm.phファイル内に無いといけません。

$os(書式：UNIX互換環境：「unix」、Windows：「win」、Macintosh：「Mac」)

「なつみかん」を動作させるマシンのOSの種類を入れます。

$url(書式：URL)

「なつみかん」を使ったサイトのURLを入れておきます。

$base(書式：絶対パス)

「なつみかん」の動作の基準となるディレクトリを絶対パスで入れておきます。
ここをきちんと設定しないと正常に動作しないのでご注意下さい。

$bin(書式：パス)

実行ファイル(nm.plなど)、設定ファイル(nm.phやsites.lirsなど)、テンプレートHTML(base.html)などを置いておくディレクトリを指定します。
ここをきちんと設定しないと正常に動作しないのでご注意下さい。

$tmp(書式：パス)

リモートサイトの情報ファイルや一時ファイルを置いておくディレクトリを指定します。

$ext(書式：パス)

HTMLやLIRS、hina.txtファイルなどを出力するディレクトリを指定します。

$localTimeZone(単位：秒)

「なつみかん」を動作させるマシンの時間帯をGMTからの誤差(秒)で指定します。
日本はJST(+0900)なので、「32400」を指定します。
なお、ここを設定するときはサマータイムは考慮に入れないようにします(サマータイムは自動的に認識するため)。

$gzip(書式：絶対パス＆ファイル名)

LIRS出力で使うgzipの場所を指定します。
UNIX環境において、場所がわからないときは、コマンドラインで

which gzip

のようにすれば、場所がわかると思います。
また、Windows環境では、http://www.gzip.org/などからダウンロードしたgzip.exeを「なつみかん」実行ファイルディレクトリにコピーした上で、

$gzip = 'gzip.exe';

とします。

$referer(書式：URL)

対象サイトにアクセスしたときに渡される「リファラー(referer)」を指定します。通常は「$nm::cf::url」としておいてください。

$http_proxy(書式：URL)

プロキシーサーバーを通さなければならないときに、そのサーバー名を指定します。

$priority(書式：数値)

「なつみかん」のサーバー上での動作優先度を0(優先度最高：setpriorityを実行しない)〜10(優先度最低)までの数値で指定します(UNIXのみ有効)。

$re(書式：絶対パス＆ファイル名)

日記システム側からの更新時刻通知を受け取るCGI「re.cgi」で、受け取った情報をLIRS形式で保存するファイルのファイル名を指定します。 このファイルはdetect::detectに読み込まれるとすぐ削除されます。

@ua(書式：文字列の配列)

日記システム側からの更新時刻通知を受け取るCGI「re.cgi」で、受信する相手プログラムのUser Agentを指定します。
User Agentにこのリストにある文字列を含んでいる通信相手のみを、更新時刻通知対象とします。
なお、何も入力されていない場合は更新時刻通知を受け入れないようになります。

@denyserver(書式：文字列の配列(サーバー名・ドメイン名))

日記システム側からの更新時刻通知を受け取るCGI「re.cgi」で、受信を禁止する相手のサーバー名・ドメイン名を指定します。
@denyserverリストに無くて、@allowserverにあるサーバーからのみ更新時刻通知を受け付けます。
この配列に何も入っていないと、受信を許可するか禁止するかは@allowserverの設定に依存するようになります。

@allowserver(書式：文字列の配列(サーバー名・ドメイン名))

日記システム側からの更新時刻通知を受け取るCGI「re.cgi」で、受信を許可する相手のサーバー名・ドメイン名を指定します。
@denyserverでの指定によりますが、通常@allowserverで指定したサーバー名・ドメイン名を持つサーバーからのみ、更新時刻情報を受け付けます。
@allowserverが空の状態だと、@denyserverチェックで引っかからなかったサーバー全てから更新時刻通知を受け付けます。
@allowserverも@denyserverも空の状態だと、全てのサーバーから更新時刻通知を受け付けるようになります。

info.cgiの設定

$nm::cf::info::????の設定値
「info.cgiの設定」は、必ずnm.phファイル内に無いといけません(使用しないときはかまいません)。

$core(書式：絶対パス＆ファイル名)

コアダンプで吐かれたcoreファイルの場所と名前を指定します。

$tgthtml(書式：絶対パス＆ファイル名)

きちんとHTMLが出力されたかどうかを判定するHTMLファイルを指定します。また、最終更新日時を判定する元となるHTMLもここで指定します。%htmlで指定したHTMLのいずれかになるでしょう。

$deffsize(単位：バイト)

$tgthtmlで指定したファイルが正常に出力されたと判断できる容量をバイト数で指定します。

$wtwestart(単位：時)

週末における混雑時間帯開始時刻を指定します。

$wtweend(単位：時)

週末における混雑時間帯終了時刻を指定します。

$ftwestart(単位：時)

週末における快適更新時間帯開始時刻を指定します。

$ftweend(単位：時)

週末における快適更新時間帯終了時刻を指定します。

$wtnmstart(単位：時)

平日における混雑時間帯開始時刻を指定します。

$wtnmend(単位：時)

平日における混雑時間帯終了時刻を指定します。

$ftnmstart(単位：時)

平日における快適更新時間帯開始時刻を指定します。

$ftnmend(単位：時)

平日における快適更新時間帯終了時刻を指定します。

これ以降は通常の置換指定子の他に、下記の置換指定子を使うことができます。
%ver%：なつみかんのバージョン

$startmes(書式：文字列)

info.cgiで、一番最初に追加する文字列を指定します。置換指定子を入れておくと、現在時刻を基準として自動的に置換されます。

$lstmod(書式：文字列)

info.cgiで、設置するサイトの最終更新日時を表記する文字列を指定します。「$tgthtml」を参照しますのでこの設定もきちんとしておく必要があります。
通常の置換指定子を入れておくと、最終更新日時を基準として自動的に置換されます。

$antennainfo(書式：文字列)

なつみかんが動作しているときのメッセージを指定します。後述の$updatetimeと排他で表示されます。
通常の置換指定子を入れておくと、なつみかん動作開始日時を基準として自動的に置換されます。

$updatetime(書式：文字列)

なつみかんが更新にかかった時刻を表記します。前述の$antennainfoと排他で表示されます。
通常の置換指定子を入れておくと、なつみかんの更新にかかった時間を基準として自動的に置換されます。

$timeinfonm(書式：文字列)

平日の混雑時間帯の時に表示されるメッセージを指定します。

$timeinfowe(書式：文字列)

週末の混雑時間帯の時に表示されるメッセージを指定します。

$timeinfoft(書式：文字列)

快適時間帯の時に表示されるメッセージを指定します。

$coreinfo(書式：文字列)

コアダンプが発生しcoreファイルが発見されたときに表示されるメッセージです。
通常の置換指定子を入れておくと、コアダンプした時間を基準として自動的に置換されます。

$idcaution(書式：文字列)

HTMLファイルの出力に失敗したときに表示されるメッセージです。

$endmes(書式：文字列)

最後に追記されるメッセージです。

nmp.cgiの設定

$nm::cf::nmp::????の設定値
「nmp.cgiの設定」は、必ずnm.phファイル内に無いといけません(使用しないときはかまいません)。

$nmpdir(書式：絶対パス)

nmp.cgi が生成する個人設定を保存しておくディレクトリです。
セキュリティ確保のため必ずデフォルトから変更してください。

$passwdfile(書式：ファイル名)

nmp.cgiが生成するパスワードファイルのファイル名です。
セキュリティ確保のため必ずデフォルトから変更してください。

@readcfg(書式：ファイル名の配列)

更新時刻取得対象設定ファイルを配列で指定します。ここで指定したファイルは、非購読対象を設定するときに使われます。
入力元は$nm::cf::binの値に従います。
「出力用設定ファイル」(@nm::cf::nmp::cfg)と同じURLリストが取得できるものを指定してください。
@nm::cf::det::cfgのようにURLで指定することはできません。通常はsites.lirsか、出力されたnatsumican.lirsを指定してください。
なお、旬・月・年でURLが変わる取得先を登録している場合は必ずsites.lirsを指定してください。

$rem(書式：ファイル名)

リモートアンテナ設定ファイルを指定します。
入力元は$nm::cf::binの値に従います。
$nm::cf::det::remのようにURLで指定することはできません。通常は「remote.cfg」を指定しておきます。

@cfg(書式：ファイル名の配列)

出力用設定ファイルを配列で指定します。ここで指定したファイルは、実際に購読リストを表示するときに使われます。
入力元は$nm::cf::binの値に従います。
「更新時刻取得対象設定ファイル」(@nm::cf::nmp::readcfg)と同じURLリストが取得できるものを指定してください。
@nm::cf::det::cfgのようにURLで指定することはできません。通常は出力されたnatsumican.lirsを指定してください。

$basefile(書式：絶対パス＆ファイル名)

nmp.cgiの出力時にテンプレートとなるHTMLファイルを絶対パス＆ファイル名で指定します。
内部の置換指定子はnmp.cgi独自のものしか使えません。そのため、テンプレートとなるベースのHTMLは別途作成してください。
なお、通常はなつみかんによる定時更新の際htmlrender::htmlrenderを通したものを指定してください。

$template(書式：文字列)

nmp.cgiのHTML出力の際の型を指定します。
置換指定子はnm::cf::htmlのものと一緒です。ただし「%etc%」の置換(&etcscript())はnm::cf::htmlが読み出せたときのみ有効です。

$template_select(書式：文字列)

nmp.cgiでサイト選択をするときのHTML出力の型を指定します。
置換指定子はnm::cf::htmlのものと一緒です。ただし「%etc%」の置換(&etcscript())はnm::cf::htmlが読み出せたときのみ有効です。また、%url%、%vurl%、%option%は正常動作しない場合がありますので使わないでください。
なお、購読希望チェックボックスを指定する「%checkbox%」置換指定子を必ず入れてください。

$introduction{"personalized"}(書式：文字列)

nmp.cgiのインフォメーション表示の際、personalizeされている時のメッセージを設定します。
ここはデフォルトではPerlのヒアドキュメントで書かれています。

$introduction{"not_personalized"}(書式：文字列)

nmp.cgiのインフォメーション表示の際、personalizeされていない時のメッセージを設定します。
ここはデフォルトではPerlのヒアドキュメントで書かれています。

$introduction{"select"}(書式：文字列)

nmp.cgiのインフォメーション表示の際、非購読サイトを設定するときのメッセージを設定します。
ここはデフォルトではPerlのヒアドキュメントで書かれています。

$introduction{"regist"}(書式：文字列)

nmp.cgiのインフォメーション表示の際、非購読サイトを登録したあとに表示されるメッセージを設定します。
ここはデフォルトではPerlのヒアドキュメントで書かれています。

$introduction{"illegal_password"}(書式：文字列)

nmp.cgiのインフォメーション表示の際、入力されたパスワードが間違えていたときに表示されるメッセージを設定します。
ここはデフォルトではPerlのヒアドキュメントで書かれています。

$introduction{"noid"}(書式：文字列)

nmp.cgiのインフォメーション表示の際、指定されたユーザー毎の設定ファイルがサーバー側に存在しなかったときに表示されるメッセージを設定します。
ここはデフォルトではPerlのヒアドキュメントで書かれています。